[libcamera-devel] [PATCH 6/6] libcamera: log: Document the LogMessage class

[Laurent Pinchart]

Fix Doxygen build warnings by adding the missing documentation for the
LogMessage class.

Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
---
 src/libcamera/log.cpp | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp
index c5345cf079a3..953f8805cb97 100644
--- a/src/libcamera/log.cpp
+++ b/src/libcamera/log.cpp
@@ -54,6 +54,20 @@ static const char *log_severity_name(LogSeverity severity)
 		return "UNKN";
 }
 
+/**
+ * \class LogMessage
+ * \brief Internal log message representation.
+ *
+ * The LogMessage class models a single message in the log. It serves as a
+ * helper to provide the std::ostream API for logging, and much never be used
+ * directly. Use the LOG() macro instead access the log infrastructure.
+ */
+
+/**
+ * Create a log message pertaining to line \a line of file \a fileName. The
+ * \a severity argument sets the message severity to control whether it will be
+ * output or dropped.
+ */
 LogMessage::LogMessage(const char *fileName, unsigned int line,
 		       LogSeverity severity)
 {
@@ -78,4 +92,12 @@ LogMessage::~LogMessage()
 	fflush(stderr);
 }
 
+/**
+ * \fn std::ostream& LogMessage::stream()
+ *
+ * Data is added to a LogMessage through the stream returned by this function.
+ * The stream implements the std::ostream API and can be used for logging as
+ * std::cout.
+ */
+
 } /* namespace libcamera */
-- 
Regards,

Laurent Pinchart