From patchwork Tue Jan 8 14:46:42 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 180 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id AB94060B2E for ; Tue, 8 Jan 2019 15:45:37 +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 13E8D586 for ; Tue, 8 Jan 2019 15:45:37 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1546958737; bh=Xa315NUsuK4oK6TcZYHJpMovKU/9+gmMkjLhEJrUNAU=; h=From:To:Subject:Date:From; b=a1PiZVoWZPDehA6ZECAEVpzMK59P3zjln6SBYerb93I5nhNiVpaa4Ds5UeJ2dRpKe J46iTNdrTCzsFK9C7wA/yoJSR97vM01y4KDsdY4vRDWyirLXAtxf1hX5CuK3fsuVJt +G+UoPsaqUU6+kyFVXmgAVy01CogSQWHfeCCvXZQ= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Tue, 8 Jan 2019 16:46:42 +0200 Message-Id: <20190108144642.10611-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.19.2 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] libcamera: Document missing parameters and return values 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, 08 Jan 2019 14:45:37 -0000 Several functions are missing documentation for some of them parameters and/or for their return value. Fix this. Signed-off-by: Laurent Pinchart Reviewed-by: Niklas Söderlund --- src/libcamera/device_enumerator.cpp | 3 +++ src/libcamera/log.cpp | 7 +++++++ src/libcamera/pipeline_handler.cpp | 8 +++++--- src/libcamera/signal.cpp | 5 +++++ 4 files changed, 20 insertions(+), 3 deletions(-) diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp index c088f3e5d243..f1d016db64a0 100644 --- a/src/libcamera/device_enumerator.cpp +++ b/src/libcamera/device_enumerator.cpp @@ -124,6 +124,9 @@ bool DeviceMatch::match(const MediaDevice *device) const * implementations may be needed. This function creates the best enumerator for * the operating system based on the available resources. Not all different * enumerator types are guaranteed to support all features. + * + * \return A pointer to the newly created device enumerator on success, or + * nullptr if an error occurs */ DeviceEnumerator *DeviceEnumerator::create() { diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp index c1ec55618ea3..281e31d963f5 100644 --- a/src/libcamera/log.cpp +++ b/src/libcamera/log.cpp @@ -90,6 +90,11 @@ static const char *log_severity_name(LogSeverity severity) */ /** + * \param fileName The file name where the message is logged from + * \param line The line number where the message is logged from + * \param severity The log message severity, controlling how the message will be + * displayed + * * 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. @@ -130,6 +135,8 @@ LogMessage::~LogMessage() * 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. + * + * \return A reference to the log message stream */ } /* namespace libcamera */ diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 093821d4c471..ee7694879848 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -36,11 +36,13 @@ namespace libcamera { /** * \fn PipelineHandler::match(DeviceEnumerator *enumerator) * \brief Match media devices and create camera instances + * \param enumerator The enumerator providing all media devices found in the + * system * * This function is the main entry point of the pipeline handler. It is called - * by the device enumerator with the enumerator passed as an argument. It shall - * acquire from the enumerator all the media devices it needs for a single - * pipeline and create one or multiple Camera instances. + * by the device enumerator with the \a enumerator passed as an argument. It + * shall acquire from the \a enumerator all the media devices it needs for a + * single pipeline and create one or multiple Camera instances. * * If all media devices needed by the pipeline handler are found, they must all * be acquired by a call to MediaDevice::acquire(). This function shall then diff --git a/src/libcamera/signal.cpp b/src/libcamera/signal.cpp index 0fd3bb2a34a1..51536dc5fdd0 100644 --- a/src/libcamera/signal.cpp +++ b/src/libcamera/signal.cpp @@ -58,21 +58,26 @@ namespace libcamera { /** * \fn Signal::disconnect(T *object) * \brief Disconnect the signal from all slots of the \a object + * \param object The object pointer whose slots to disconnect */ /** * \fn Signal::disconnect(T *object, void(T::*func)(Args...)) * \brief Disconnect the signal from the \a object slot member function \a func + * \param object The object pointer whose slots to disconnect + * \param func The slot member function to disconnect */ /** * \fn Signal::disconnect(void(*func)(Args...)) * \brief Disconnect the signal from the slot static function \a func + * \param func The slot static function to disconnect */ /** * \fn Signal::emit(Args... args) * \brief Emit the signal and call all connected slots + * \param args The arguments passed to the connected slots * * Emitting a signal calls all connected slots synchronously and sequentially in * the order the slots have been connected. The arguments passed to the emit()