fix clang -Wdocumentation warnings

odygrd · May 12, 2020 · 4148ebb · 4148ebb
1 parent c62b1b4
commit 4148ebb
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 6 deletions.
diff --git a/quill/include/quill/Logger.h b/quill/include/quill/Logger.h
@@ -87,7 +87,6 @@ class alignas(detail::CACHELINE_SIZE) Logger
    * One queue per caller thread.
    * We have this enable_if to use unlikely since no if constexpr in C++14
    * @note This function is thread-safe.
-   * @param log_line_info log line info pointer
    * @param fmt_args format arguments
    */
   template <typename TLogRecordMetadata, typename... FmtArgs>

diff --git a/quill/include/quill/detail/BackendWorker.h b/quill/include/quill/detail/BackendWorker.h
@@ -70,7 +70,7 @@ class BackendWorker
 
   /**
    * Get the backend worker's thread id
-   * @return
+   * @return the backend worker's thread id
    */
   QUILL_NODISCARD uint32_t thread_id() const noexcept;
 
@@ -115,7 +115,6 @@ class BackendWorker
 
   /**
    * Checks for records in all queues and processes the one with the minimum timestamp
-   * @return true if one record was found and processed
    */
   QUILL_ATTRIBUTE_HOT inline void _process_record();
 
@@ -127,7 +126,7 @@ class BackendWorker
   /**
    * Convert a log record timestamp to a time since epoch timestamp in nanoseconds.
    *
-   * @param log_record_handle The log record timestamp is just an uint64 and it can be either
+   * @param log_record The log record timestamp is just an uint64 and it can be either
    * rdtsc time or nanoseconds since epoch based on #if !defined(QUILL_CHRONO_CLOCK) definition
    * @return a timestamp in nanoseconds since epoch
    */

diff --git a/quill/include/quill/detail/record/LogRecord.h b/quill/include/quill/detail/record/LogRecord.h
@@ -32,7 +32,6 @@ class LogRecord final : public RecordBase
    * Make a new LogRecord.
    * This is created by the caller every time we want to log a new message
    * To perfectly forward the argument we have to provide a templated contructor
-   * @param log_line_info log line info constexpr object
    * @param logger_details logger object details
    * @param fmt_args format arguments
    */

diff --git a/quill/include/quill/detail/record/RecordBase.h b/quill/include/quill/detail/record/RecordBase.h
@@ -36,7 +36,7 @@ class RecordBase
 
   /**
    * Virtual clone
-   * @return
+   * @return a copy of record base
    */
   virtual std::unique_ptr<RecordBase> clone() const = 0;