From patchwork Fri Mar 6 15:59:33 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2975 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id BB45F6285C for ; Fri, 6 Mar 2020 17:00:12 +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 1B444A48; Fri, 6 Mar 2020 17:00:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1583510412; bh=ZBHYvBkcVV4MISNlXC1xizfdw9CupPYqZuw++xBl9dM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=isz8UD2HI6vZocTmiOc59CpLKD14S3dOcLbNvNLgCdhusR4gpTpjaTc5SP/FqKv2j 2fkH10YrI1frTP5DNJ4Ld7Vq4q4bX8gahripqLCygnyi5JVTIfaS91kviSM4n037ZG 7G1XVAlCy9k5CpRnN15xDDZal4oTNG9sK788Vt8U= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Date: Fri, 6 Mar 2020 17:59:33 +0200 Message-Id: <20200306160002.30549-4-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200306160002.30549-1-laurent.pinchart@ideasonboard.com> References: <20200306160002.30549-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2 03/32] 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: Fri, 06 Mar 2020 16:00:13 -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 property names should not need any additional information specified for Doxygen to correctly identify them. Signed-off-by: Jacopo Mondi Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham --- Changes since v1: - Commit message updates --- 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}");')