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>
This commit is contained in:
Laurent Pinchart 2018-12-11 21:03:35 +02:00
parent b4351e1a6b
commit 6ab3ff4501

View file

@ -54,6 +54,20 @@ static const char *log_severity_name(LogSeverity severity)
return "UNKN"; 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, LogMessage::LogMessage(const char *fileName, unsigned int line,
LogSeverity severity) LogSeverity severity)
{ {
@ -78,4 +92,12 @@ LogMessage::~LogMessage()
fflush(stderr); 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 */ } /* namespace libcamera */