[{"id":40,"web_url":"https://patchwork.libcamera.org/comment/40/","msgid":"<20181212131748.GP5597@w540>","date":"2018-12-12T13:17:48","subject":"Re: [libcamera-devel] [PATCH 6/6] libcamera: log: Document the\n\tLogMessage class","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent,\n  a small thing I noticed while looking at the generated documentation\n\nOn Tue, Dec 11, 2018 at 09:10:11PM +0200, Laurent Pinchart wrote:\n> Fix Doxygen build warnings by adding the missing documentation for the\n> LogMessage class.\n>\n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  src/libcamera/log.cpp | 22 ++++++++++++++++++++++\n>  1 file changed, 22 insertions(+)\n>\n> diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp\n> index c5345cf079a3..953f8805cb97 100644\n> --- a/src/libcamera/log.cpp\n> +++ b/src/libcamera/log.cpp\n> @@ -54,6 +54,20 @@ static const char *log_severity_name(LogSeverity severity)\n>  \t\treturn \"UNKN\";\n>  }\n>\n> +/**\n> + * \\class LogMessage\n> + * \\brief Internal log message representation.\n> + *\n> + * The LogMessage class models a single message in the log. It serves as a\n> + * helper to provide the std::ostream API for logging, and much never be used\n\ns/much/must ?\n\nThanks\n   j\n\n> + * directly. Use the LOG() macro instead access the log infrastructure.\n> + */\n> +\n> +/**\n> + * Create a log message pertaining to line \\a line of file \\a fileName. The\n> + * \\a severity argument sets the message severity to control whether it will be\n> + * output or dropped.\n> + */\n>  LogMessage::LogMessage(const char *fileName, unsigned int line,\n>  \t\t       LogSeverity severity)\n>  {\n> @@ -78,4 +92,12 @@ LogMessage::~LogMessage()\n>  \tfflush(stderr);\n>  }\n>\n> +/**\n> + * \\fn std::ostream& LogMessage::stream()\n> + *\n> + * Data is added to a LogMessage through the stream returned by this function.\n> + * The stream implements the std::ostream API and can be used for logging as\n> + * std::cout.\n> + */\n> +\n>  } /* namespace libcamera */\n> --\n> Regards,\n>\n> Laurent Pinchart\n>\n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"<jacopo@jmondi.org>","Received":["from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net\n\t[217.70.183.201])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8689A60A71\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 12 Dec 2018 14:17:50 +0100 (CET)","from w540 (2-224-242-101.ip172.fastwebnet.it [2.224.242.101])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 15C431BF204;\n\tWed, 12 Dec 2018 13:17:49 +0000 (UTC)"],"X-Originating-IP":"2.224.242.101","Date":"Wed, 12 Dec 2018 14:17:48 +0100","From":"jacopo mondi <jacopo@jmondi.org>","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20181212131748.GP5597@w540>","References":"<20181211191011.6315-1-laurent.pinchart@ideasonboard.com>\n\t<20181211191011.6315-7-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"multipart/signed; micalg=pgp-sha256;\n\tprotocol=\"application/pgp-signature\"; boundary=\"oN4OvwWIcd1E23D1\"","Content-Disposition":"inline","In-Reply-To":"<20181211191011.6315-7-laurent.pinchart@ideasonboard.com>","User-Agent":"Mutt/1.5.24 (2015-08-30)","Subject":"Re: [libcamera-devel] [PATCH 6/6] libcamera: log: Document the\n\tLogMessage class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Wed, 12 Dec 2018 13:17:50 -0000"}},{"id":45,"web_url":"https://patchwork.libcamera.org/comment/45/","msgid":"<4712149.8BhtZgbDqh@avalon>","date":"2018-12-12T18:18:13","subject":"Re: [libcamera-devel] [PATCH 6/6] libcamera: log: Document the\n\tLogMessage class","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Jacopo,\n\nOn Wednesday, 12 December 2018 15:17:48 EET jacopo mondi wrote:\n> Hi Laurent,\n>   a small thing I noticed while looking at the generated documentation\n> \n> On Tue, Dec 11, 2018 at 09:10:11PM +0200, Laurent Pinchart wrote:\n> > Fix Doxygen build warnings by adding the missing documentation for the\n> > LogMessage class.\n> > \n> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> > ---\n> > \n> >  src/libcamera/log.cpp | 22 ++++++++++++++++++++++\n> >  1 file changed, 22 insertions(+)\n> > \n> > diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp\n> > index c5345cf079a3..953f8805cb97 100644\n> > --- a/src/libcamera/log.cpp\n> > +++ b/src/libcamera/log.cpp\n> > @@ -54,6 +54,20 @@ static const char *log_severity_name(LogSeverity\n> > severity)> \n> >  \t\treturn \"UNKN\";\n> >  \n> >  }\n> > \n> > +/**\n> > + * \\class LogMessage\n> > + * \\brief Internal log message representation.\n> > + *\n> > + * The LogMessage class models a single message in the log. It serves as\n> > a\n> > + * helper to provide the std::ostream API for logging, and much never be\n> > used\n> \n> s/much/must ?\n\nOf course. I'll fix that.\n\n> > + * directly. Use the LOG() macro instead access the log infrastructure.\n> > + */\n> > +\n\n[snip]","headers":{"Return-Path":"<laurent.pinchart@ideasonboard.com>","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 57A5860A71\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 12 Dec 2018 19:17:27 +0100 (CET)","from avalon.localnet (dfj612ybrt5fhg77mgycy-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00:2e86:4862:ef6a:2804])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id BCE5C55A;\n\tWed, 12 Dec 2018 19:17:26 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1544638646;\n\tbh=4Nbk99oqKspaajOWtkuSXk0+OnShluQj3ZbSEtTQ2xI=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=EUFq/w8UeBHWRX2JhGocsrxa6i2oF2Ld3EEOaC1CldP8oL/4SNHtCACR/ZMNl3wkq\n\t3k3fwzdYjzsH5VVWZBnBwlpdunPjMeQkYnzU407IASzsmJWw39NhAZ9wd7412P0wn5\n\tf0GuM/y6xqESdTiWPyK5JVfGWpiMfAdko7EfIT30=","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"jacopo mondi <jacopo@jmondi.org>","Cc":"libcamera-devel@lists.libcamera.org","Date":"Wed, 12 Dec 2018 20:18:13 +0200","Message-ID":"<4712149.8BhtZgbDqh@avalon>","Organization":"Ideas on Board Oy","In-Reply-To":"<20181212131748.GP5597@w540>","References":"<20181211191011.6315-1-laurent.pinchart@ideasonboard.com>\n\t<20181211191011.6315-7-laurent.pinchart@ideasonboard.com>\n\t<20181212131748.GP5597@w540>","MIME-Version":"1.0","Content-Transfer-Encoding":"7Bit","Content-Type":"text/plain; charset=\"us-ascii\"","Subject":"Re: [libcamera-devel] [PATCH 6/6] libcamera: log: Document the\n\tLogMessage class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","X-List-Received-Date":"Wed, 12 Dec 2018 18:17:27 -0000"}}]