{"id":35,"url":"https://patchwork.libcamera.org/api/patches/35/?format=json","web_url":"https://patchwork.libcamera.org/patch/35/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20181211191011.6315-7-laurent.pinchart@ideasonboard.com>","date":"2018-12-11T19:10:11","name":"[libcamera-devel,6/6] libcamera: log: Document the LogMessage class","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"785b6b5f57916cd3fcd06d45fb59e0e6efd5e9c4","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/35/mbox/","series":[{"id":16,"url":"https://patchwork.libcamera.org/api/series/16/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=16","date":"2018-12-11T19:10:05","name":"Documentation: Initial Doxygen support","version":1,"mbox":"https://patchwork.libcamera.org/series/16/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/35/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/35/checks/","tags":{},"headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 142F260B19\n\tfor ;\n\tTue, 11 Dec 2018 20:09:46 +0100 (CET)","from avalon.bb.dnainternet.fi\n\t(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 5459155A\n\tfor ;\n\tTue, 11 Dec 2018 20:09:45 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1544555385;\n\tbh=vBFvUxhAW2Dj8a8Fv1i9P+0JMWwzAgr+M0AcEOXz14I=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=rhfiaGmCjvepSkewtk6h9khkcU/0jOnwe/5NjCl0mJZ2eXVSmNb+LmD3nSQepb2T6\n\tN/gcaqaljSodUoolmTBaY0O8gkOUiArcFRmxmNTGYBx2x4UuGmoWC6/d+LuExjv+G/\n\tgkORxOlsqrtJeGOKpeZneMXCKrxXUECeierwd4KQ=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 11 Dec 2018 21:10:11 +0200","Message-Id":"<20181211191011.6315-7-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.19.2","In-Reply-To":"<20181211191011.6315-1-laurent.pinchart@ideasonboard.com>","References":"<20181211191011.6315-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[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":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Tue, 11 Dec 2018 19:09:46 -0000"},"content":"Fix Doxygen build warnings by adding the missing documentation for the\nLogMessage class.\n\nSigned-off-by: Laurent Pinchart \n---\n src/libcamera/log.cpp | 22 ++++++++++++++++++++++\n 1 file changed, 22 insertions(+)","diff":"diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp\nindex 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+ * 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","prefixes":["libcamera-devel","6/6"]}