From patchwork Tue Dec 11 19:10:11 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 35 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 142F260B19 for ; Tue, 11 Dec 2018 20:09:46 +0100 (CET) Received: from avalon.bb.dnainternet.fi (dfj612ybrt5fhg77mgycy-3.rev.dnainternet.fi [IPv6:2001:14ba:21f5:5b00:2e86:4862:ef6a:2804]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 5459155A for ; Tue, 11 Dec 2018 20:09:45 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1544555385; bh=vBFvUxhAW2Dj8a8Fv1i9P+0JMWwzAgr+M0AcEOXz14I=; h=From:To:Subject:Date:In-Reply-To:References:From; b=rhfiaGmCjvepSkewtk6h9khkcU/0jOnwe/5NjCl0mJZ2eXVSmNb+LmD3nSQepb2T6 N/gcaqaljSodUoolmTBaY0O8gkOUiArcFRmxmNTGYBx2x4UuGmoWC6/d+LuExjv+G/ gkORxOlsqrtJeGOKpeZneMXCKrxXUECeierwd4KQ= 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 Subject: [libcamera-devel] [PATCH 6/6] libcamera: log: Document the LogMessage class X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 11 Dec 2018 19:09:46 -0000 Fix Doxygen build warnings by adding the missing documentation for the LogMessage class. Signed-off-by: Laurent Pinchart --- 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 + * 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 */