summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2018-12-11 21:03:35 +0200
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2018-12-12 20:45:39 +0200
commit6ab3ff4501fcfa24db40fcccbce35bdded7cd4bc (patch)
tree9e2a57fe2916b3c1f5b5721c7fae9a258923bc24
parentb4351e1a6b83a9cfbfc331af3753602a02dbe062 (diff)
libcamera: log: Document the LogMessage class
Fix Doxygen build warnings by adding the missing documentation for the LogMessage class. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
-rw-r--r--src/libcamera/log.cpp22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp
index c5345cf0..3715e69d 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 must 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 */