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

[Laurent Pinchart]

Hi Jacopo,

On Wednesday, 12 December 2018 15:17:48 EET jacopo mondi wrote:
> 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 ?

Of course. I'll fix that.

> > + * directly. Use the LOG() macro instead access the log infrastructure.
> > + */
> > +

[snip]

-- 
Regards,

Laurent Pinchart