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

[jacopo mondi]

Hi Laurent,
  a small thing I noticed while looking at the generated documentation

On Tue, Dec 11, 2018 at 09:10:11PM +0200, Laurent Pinchart wrote:
> 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

s/much/must ?

Thanks
   j

> + * 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
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel at lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <https://lists.libcamera.org/pipermail/libcamera-devel/attachments/20181212/7b005e87/attachment.sig>