[{"id":17203,"web_url":"https://patchwork.libcamera.org/comment/17203/","msgid":"<YKuneVtU6VyhJu92@pendragon.ideasonboard.com>","date":"2021-05-24T13:17:45","subject":"Re: [libcamera-devel] [RFC PATCH 2/6] utils: ipc: Prevent struct\n\tconstructors from being parsed by doxygen","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Paul,\n\nThank you for the patch.\n\nOn Mon, May 24, 2021 at 05:40:25PM +0900, Paul Elder wrote:\n> Currently the generated constructors for structs defined in mojom files\n> is being parsed by mojom. As the parameters are simply the struct\n> members, they are already documented, and the documentation of the\n> constructor is pointless. Protect them against being parsed by doxygen.\n> \n> Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>\n\nLooks good to me, but this change is already present in master :-)\n\n> ---\n>  .../generators/libcamera_templates/definition_functions.tmpl   | 3 +++\n>  1 file changed, 3 insertions(+)\n> \n> diff --git a/utils/ipc/generators/libcamera_templates/definition_functions.tmpl b/utils/ipc/generators/libcamera_templates/definition_functions.tmpl\n> index cdd75f89..94bb4918 100644\n> --- a/utils/ipc/generators/libcamera_templates/definition_functions.tmpl\n> +++ b/utils/ipc/generators/libcamera_templates/definition_functions.tmpl\n> @@ -25,6 +25,7 @@ enum {{enum.mojom_name}} {\n>  struct {{struct.mojom_name}}\n>  {\n>  public:\n> +#ifndef __DOXYGEN__\n>  \t{{struct.mojom_name}}() {%- if struct|has_default_fields %}\n>  \t\t:{% endif %}\n>  {%- for field in struct.fields|with_default_values -%}\n> @@ -44,6 +45,8 @@ public:\n>  {%- endfor %}\n>  \t{\n>  \t}\n> +#endif\n> +\n>  {% for field in struct.fields %}\n>  \t{{field|name}} {{field.mojom_name}};\n>  {%- endfor %}","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 10134C3200\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 24 May 2021 13:17:51 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 8082E68919;\n\tMon, 24 May 2021 15:17:50 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 0B1D3601AA\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 24 May 2021 15:17:49 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 72A1BED;\n\tMon, 24 May 2021 15:17:48 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"fLfSx6B6\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1621862268;\n\tbh=HkgqHvV1i8D0gwR8LTBkdEruIsqvGfjD3WyKb87y9hs=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=fLfSx6B6IOrpwjfVWXOgkcJjljul0bMywKblRhIaWevlQsTHcIdrFnb1f6SKnegJs\n\t2LOSRRzMqD0D7VLz1GefMIdiBBJY+gmWMSYXkjM81ELnWnlj+4iv+u7HpGrJ2b/6WC\n\tWV/hxLr+DFHZtiGldPIN0kWY+TnxzOoMMwi/icpc=","Date":"Mon, 24 May 2021 16:17:45 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Paul Elder <paul.elder@ideasonboard.com>","Message-ID":"<YKuneVtU6VyhJu92@pendragon.ideasonboard.com>","References":"<20210524084029.1179881-1-paul.elder@ideasonboard.com>\n\t<20210524084029.1179881-3-paul.elder@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20210524084029.1179881-3-paul.elder@ideasonboard.com>","Subject":"Re: [libcamera-devel] [RFC PATCH 2/6] utils: ipc: Prevent struct\n\tconstructors from being parsed by doxygen","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]