From patchwork Sat Feb 29 16:42:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2921 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 44FE462789 for ; Sat, 29 Feb 2020 17:43:23 +0100 (CET) Received: from pendragon.bb.dnainternet.fi (81-175-216-236.bb.dnainternet.fi [81.175.216.236]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id C91EAA28; Sat, 29 Feb 2020 17:43:22 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1582994603; bh=25QrjndSjN/tGA2KGr+Azbv20+Akchee2Dn86gYqtnw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=o1VGzC2lN/v7t4f3yNoOZlA9XNvPAaMEamHJYPYQAuX+YMboSCHcGTq8KD2iMyN9A CO+F29Orl3CfVvmY+ERJcHZrlOl6raXTW4UNJRY8G2XaGSUqjXmh5VBr2wECvPFvKY eFFFMdCRWoHUKJTxP/KDXASun56CuQjKhLwL4Fkg= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Sat, 29 Feb 2020 18:42:26 +0200 Message-Id: <20200229164254.23604-4-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200229164254.23604-1-laurent.pinchart@ideasonboard.com> References: <20200229164254.23604-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 03/31] libcamera: gen-controls: Fix documentation issue with << X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 29 Feb 2020 16:43:24 -0000 From: Jacopo Mondi Doxygen fails to parse entries with multiple << signs as, in example, \var extern const Control> Remove the type from the control documentation as unique control and properties name should not need any additional information specified for Doxygen to correctly identify them. Not sure this patch is the right way to fix this, but it's mostly here to highlight an issue. Signed-off-by: Jacopo Mondi Reviewed-by: Kieran Bingham --- src/libcamera/gen-controls.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py index 773e9b5d170c..6f020a327827 100755 --- a/src/libcamera/gen-controls.py +++ b/src/libcamera/gen-controls.py @@ -29,7 +29,7 @@ def generate_cpp(controls): enum_doc_value_template = string.Template(''' * \\var ${name}Values::${value} ${description}''') doc_template = string.Template('''/** - * \\var extern const Control<${type}> ${name} + * \\var ${name} ${description} */''') def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, "${name}");')