{"id":180,"url":"https://patchwork.libcamera.org/api/patches/180/?format=json","web_url":"https://patchwork.libcamera.org/patch/180/","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":"<20190108144642.10611-1-laurent.pinchart@ideasonboard.com>","date":"2019-01-08T14:46:42","name":"[libcamera-devel] libcamera: Document missing parameters and return values","commit_ref":"93a037efff7b8afd04aad76f6b6a4514acb6f670","pull_url":null,"state":"accepted","archived":false,"hash":"015de10eeb392256f00e77cb90fc9c2602b06189","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/180/mbox/","series":[{"id":60,"url":"https://patchwork.libcamera.org/api/series/60/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=60","date":"2019-01-08T14:46:42","name":"[libcamera-devel] libcamera: Document missing parameters and return values","version":1,"mbox":"https://patchwork.libcamera.org/series/60/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/180/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/180/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 AB94060B2E\n\tfor ;\n\tTue, 8 Jan 2019 15:45:37 +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 13E8D586\n\tfor ;\n\tTue, 8 Jan 2019 15:45:37 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1546958737;\n\tbh=Xa315NUsuK4oK6TcZYHJpMovKU/9+gmMkjLhEJrUNAU=;\n\th=From:To:Subject:Date:From;\n\tb=a1PiZVoWZPDehA6ZECAEVpzMK59P3zjln6SBYerb93I5nhNiVpaa4Ds5UeJ2dRpKe\n\tJ46iTNdrTCzsFK9C7wA/yoJSR97vM01y4KDsdY4vRDWyirLXAtxf1hX5CuK3fsuVJt\n\t+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","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH] libcamera: Document missing parameters\n\tand return values","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, 08 Jan 2019 14:45:37 -0000"},"content":"Several functions are missing documentation for some of them parameters\nand/or for their return value. Fix this.\n\nSigned-off-by: Laurent Pinchart \n---\n src/libcamera/device_enumerator.cpp | 3 +++\n src/libcamera/log.cpp | 7 +++++++\n src/libcamera/pipeline_handler.cpp | 8 +++++---\n src/libcamera/signal.cpp | 5 +++++\n 4 files changed, 20 insertions(+), 3 deletions(-)","diff":"diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp\nindex c088f3e5d243..f1d016db64a0 100644\n--- a/src/libcamera/device_enumerator.cpp\n+++ b/src/libcamera/device_enumerator.cpp\n@@ -124,6 +124,9 @@ bool DeviceMatch::match(const MediaDevice *device) const\n * implementations may be needed. This function creates the best enumerator for\n * the operating system based on the available resources. Not all different\n * enumerator types are guaranteed to support all features.\n+ *\n+ * \\return A pointer to the newly created device enumerator on success, or\n+ * nullptr if an error occurs\n */\n DeviceEnumerator *DeviceEnumerator::create()\n {\ndiff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp\nindex c1ec55618ea3..281e31d963f5 100644\n--- a/src/libcamera/log.cpp\n+++ b/src/libcamera/log.cpp\n@@ -90,6 +90,11 @@ static const char *log_severity_name(LogSeverity severity)\n */\n \n /**\n+ * \\param fileName The file name where the message is logged from\n+ * \\param line The line number where the message is logged from\n+ * \\param severity The log message severity, controlling how the message will be\n+ * displayed\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@@ -130,6 +135,8 @@ LogMessage::~LogMessage()\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+ * \\return A reference to the log message stream\n */\n \n } /* namespace libcamera */\ndiff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp\nindex 093821d4c471..ee7694879848 100644\n--- a/src/libcamera/pipeline_handler.cpp\n+++ b/src/libcamera/pipeline_handler.cpp\n@@ -36,11 +36,13 @@ namespace libcamera {\n /**\n * \\fn PipelineHandler::match(DeviceEnumerator *enumerator)\n * \\brief Match media devices and create camera instances\n+ * \\param enumerator The enumerator providing all media devices found in the\n+ * system\n *\n * This function is the main entry point of the pipeline handler. It is called\n- * by the device enumerator with the enumerator passed as an argument. It shall\n- * acquire from the enumerator all the media devices it needs for a single\n- * pipeline and create one or multiple Camera instances.\n+ * by the device enumerator with the \\a enumerator passed as an argument. It\n+ * shall acquire from the \\a enumerator all the media devices it needs for a\n+ * single pipeline and create one or multiple Camera instances.\n *\n * If all media devices needed by the pipeline handler are found, they must all\n * be acquired by a call to MediaDevice::acquire(). This function shall then\ndiff --git a/src/libcamera/signal.cpp b/src/libcamera/signal.cpp\nindex 0fd3bb2a34a1..51536dc5fdd0 100644\n--- a/src/libcamera/signal.cpp\n+++ b/src/libcamera/signal.cpp\n@@ -58,21 +58,26 @@ namespace libcamera {\n /**\n * \\fn Signal::disconnect(T *object)\n * \\brief Disconnect the signal from all slots of the \\a object\n+ * \\param object The object pointer whose slots to disconnect\n */\n \n /**\n * \\fn Signal::disconnect(T *object, void(T::*func)(Args...))\n * \\brief Disconnect the signal from the \\a object slot member function \\a func\n+ * \\param object The object pointer whose slots to disconnect\n+ * \\param func The slot member function to disconnect\n */\n \n /**\n * \\fn Signal::disconnect(void(*func)(Args...))\n * \\brief Disconnect the signal from the slot static function \\a func\n+ * \\param func The slot static function to disconnect\n */\n \n /**\n * \\fn Signal::emit(Args... args)\n * \\brief Emit the signal and call all connected slots\n+ * \\param args The arguments passed to the connected slots\n *\n * Emitting a signal calls all connected slots synchronously and sequentially in\n * the order the slots have been connected. The arguments passed to the emit()\n","prefixes":["libcamera-devel"]}