{"id":1858,"url":"https://patchwork.libcamera.org/api/1.1/patches/1858/?format=json","web_url":"https://patchwork.libcamera.org/patch/1858/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20190827095008.11405-3-jacopo@jmondi.org>","date":"2019-08-27T09:50:02","name":"[libcamera-devel,v2,2/7] libcamera: controls: Document control_ids.h","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"cd4ff8bc1f657f3f8a0c0af26b83dc5fe39955c6","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/1.1/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":{"id":15,"url":"https://patchwork.libcamera.org/api/1.1/users/15/?format=json","username":"jmondi","first_name":"Jacopo","last_name":"Mondi","email":"jacopo@jmondi.org"},"mbox":"https://patchwork.libcamera.org/patch/1858/mbox/","series":[{"id":468,"url":"https://patchwork.libcamera.org/api/1.1/series/468/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=468","date":"2019-08-27T09:50:00","name":"libcamera: camera_sensor: Collect camera location and sizes","version":2,"mbox":"https://patchwork.libcamera.org/series/468/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/1858/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/1858/checks/","tags":{},"headers":{"Return-Path":"","Received":["from relay11.mail.gandi.net (relay11.mail.gandi.net\n\t[217.70.178.231])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9D4F660C37\n\tfor ;\n\tTue, 27 Aug 2019 11:48:45 +0200 (CEST)","from uno.homenet.telecomitalia.it (unknown [87.18.63.98])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay11.mail.gandi.net (Postfix) with ESMTPSA id 168F2100003;\n\tTue, 27 Aug 2019 09:48:44 +0000 (UTC)"],"From":"Jacopo Mondi ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 27 Aug 2019 11:50:02 +0200","Message-Id":"<20190827095008.11405-3-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.23.0","In-Reply-To":"<20190827095008.11405-1-jacopo@jmondi.org>","References":"<20190827095008.11405-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v2 2/7] libcamera: controls: Document\n\tcontrol_ids.h","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, 27 Aug 2019 09:48:45 -0000"},"content":"The control identifiers documentation was not generated as they're not\npart of the controls.h file documented in controls.cpp.\n\nMove documentation for control id to the end of the controls.cpp and\ndocument the control_ids.h file to have documentation for controls\nproperly generated.\n\nSigned-off-by: Jacopo Mondi \n---\n src/libcamera/controls.cpp | 100 ++++++++++++++++++++-----------------\n 1 file changed, 53 insertions(+), 47 deletions(-)","diff":"diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp\nindex 727fdbd9450d..9adc3badc254 100644\n--- a/src/libcamera/controls.cpp\n+++ b/src/libcamera/controls.cpp\n@@ -181,53 +181,6 @@ std::string ControlValue::toString() const\n \treturn \"\";\n }\n \n-/**\n- * \\enum ControlId\n- * \\brief Numerical control ID\n- */\n-\n-/**\n- * \\var AwbEnable\n- * ControlType: Bool\n- *\n- * Enables or disables the AWB. See also \\a libcamera::ControlId::ManualGain\n- */\n-\n-/**\n- * \\var Brightness\n- * ControlType: Integer\n- *\n- * Specify a fixed brightness parameter.\n- */\n-\n-/**\n- * \\var Contrast\n- * ControlType: Integer\n- *\n- * Specify a fixed contrast parameter.\n- */\n-\n-/**\n- * \\var Saturation\n- * ControlType: Integer\n- *\n- * Specify a fixed saturation parameter.\n- */\n-\n-/**\n- * \\var ManualExposure\n- * ControlType: Integer\n- *\n- * Specify a fixed exposure time in milli-seconds\n- */\n-\n-/**\n- * \\var ManualGain\n- * ControlType: Integer\n- *\n- * Specify a fixed gain parameter\n- */\n-\n /**\n * \\struct ControlIdentifier\n * \\brief Describe a ControlId with control specific constant meta-data\n@@ -549,4 +502,57 @@ void ControlList::update(const ControlList &other)\n \t}\n }\n \n+/**\n+ * \\file control_ids.h\n+ * \\brief Definition of numerical identifiers for libcamera control and\n+ * properties\n+ */\n+\n+/**\n+ * \\enum ControlId\n+ * \\brief Numerical control ID\n+ */\n+\n+/**\n+ * \\var AwbEnable\n+ * ControlType: Bool\n+ *\n+ * Enables or disables the AWB. See also \\a libcamera::ControlId::ManualGain\n+ */\n+\n+/**\n+ * \\var Brightness\n+ * ControlType: Integer\n+ *\n+ * Specify a fixed brightness parameter.\n+ */\n+\n+/**\n+ * \\var Contrast\n+ * ControlType: Integer\n+ *\n+ * Specify a fixed contrast parameter.\n+ */\n+\n+/**\n+ * \\var Saturation\n+ * ControlType: Integer\n+ *\n+ * Specify a fixed saturation parameter.\n+ */\n+\n+/**\n+ * \\var ManualExposure\n+ * ControlType: Integer\n+ *\n+ * Specify a fixed exposure time in milli-seconds\n+ */\n+\n+/**\n+ * \\var ManualGain\n+ * ControlType: Integer\n+ *\n+ * Specify a fixed gain parameter\n+ */\n+\n } /* namespace libcamera */\n","prefixes":["libcamera-devel","v2","2/7"]}