From patchwork Tue Aug 27 09:50:02 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 1858 X-Patchwork-Delegate: jacopo@jmondi.org Return-Path: Received: from relay11.mail.gandi.net (relay11.mail.gandi.net [217.70.178.231]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 9D4F660C37 for ; Tue, 27 Aug 2019 11:48:45 +0200 (CEST) Received: from uno.homenet.telecomitalia.it (unknown [87.18.63.98]) (Authenticated sender: jacopo@jmondi.org) by relay11.mail.gandi.net (Postfix) with ESMTPSA id 168F2100003; Tue, 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 Subject: [libcamera-devel] [PATCH v2 2/7] libcamera: controls: Document control_ids.h 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, 27 Aug 2019 09:48:45 -0000 The control identifiers documentation was not generated as they're not part of the controls.h file documented in controls.cpp. Move documentation for control id to the end of the controls.cpp and document the control_ids.h file to have documentation for controls properly generated. Signed-off-by: Jacopo Mondi Reviewed-by: Niklas Söderlund --- src/libcamera/controls.cpp | 100 ++++++++++++++++++++----------------- 1 file changed, 53 insertions(+), 47 deletions(-) diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp index 727fdbd9450d..9adc3badc254 100644 --- a/src/libcamera/controls.cpp +++ b/src/libcamera/controls.cpp @@ -181,53 +181,6 @@ std::string ControlValue::toString() const return ""; } -/** - * \enum ControlId - * \brief Numerical control ID - */ - -/** - * \var AwbEnable - * ControlType: Bool - * - * Enables or disables the AWB. See also \a libcamera::ControlId::ManualGain - */ - -/** - * \var Brightness - * ControlType: Integer - * - * Specify a fixed brightness parameter. - */ - -/** - * \var Contrast - * ControlType: Integer - * - * Specify a fixed contrast parameter. - */ - -/** - * \var Saturation - * ControlType: Integer - * - * Specify a fixed saturation parameter. - */ - -/** - * \var ManualExposure - * ControlType: Integer - * - * Specify a fixed exposure time in milli-seconds - */ - -/** - * \var ManualGain - * ControlType: Integer - * - * Specify a fixed gain parameter - */ - /** * \struct ControlIdentifier * \brief Describe a ControlId with control specific constant meta-data @@ -549,4 +502,57 @@ void ControlList::update(const ControlList &other) } } +/** + * \file control_ids.h + * \brief Definition of numerical identifiers for libcamera control and + * properties + */ + +/** + * \enum ControlId + * \brief Numerical control ID + */ + +/** + * \var AwbEnable + * ControlType: Bool + * + * Enables or disables the AWB. See also \a libcamera::ControlId::ManualGain + */ + +/** + * \var Brightness + * ControlType: Integer + * + * Specify a fixed brightness parameter. + */ + +/** + * \var Contrast + * ControlType: Integer + * + * Specify a fixed contrast parameter. + */ + +/** + * \var Saturation + * ControlType: Integer + * + * Specify a fixed saturation parameter. + */ + +/** + * \var ManualExposure + * ControlType: Integer + * + * Specify a fixed exposure time in milli-seconds + */ + +/** + * \var ManualGain + * ControlType: Integer + * + * Specify a fixed gain parameter + */ + } /* namespace libcamera */