{"id":12371,"url":"https://patchwork.libcamera.org/api/1.1/patches/12371/?format=json","web_url":"https://patchwork.libcamera.org/patch/12371/","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":"<20210524084029.1179881-3-paul.elder@ideasonboard.com>","date":"2021-05-24T08:40:25","name":"[libcamera-devel,RFC,2/6] utils: ipc: Prevent struct constructors from being parsed by doxygen","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"e829801a3979940be1e2aac28f0280dddcd10939","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/1.1/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/12371/mbox/","series":[{"id":2051,"url":"https://patchwork.libcamera.org/api/1.1/series/2051/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2051","date":"2021-05-24T08:40:23","name":"Generate docs from mojom files","version":1,"mbox":"https://patchwork.libcamera.org/series/2051/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/12371/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/12371/checks/","tags":{},"headers":{"Return-Path":"","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 DE38EC3200\n\tfor ;\n\tMon, 24 May 2021 08:40:44 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A347E68919;\n\tMon, 24 May 2021 10:40:44 +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 8C715602B1\n\tfor ;\n\tMon, 24 May 2021 10:40:43 +0200 (CEST)","from pyrite.rasen.tech (unknown\n\t[IPv6:2400:4051:61:600:2c71:1b79:d06d:5032])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C08981315;\n\tMon, 24 May 2021 10:40:41 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"HRgmTIMG\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1621845643;\n\tbh=6+VUGG4UnnfstfHXegh5SFjp7GGKtXRz6SxDB7hN3aw=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=HRgmTIMGKaF0QB65fZiC7LSjwTJpusxKCgzVzjEeH2N4trdMZX6yDl9xC/4U3gZfd\n\tNxK2z70VNEx1OxULpnuNvJkLxuQaglc8fxlUsX2+tSh6rqrJnaEap0KeOsKYATekQw\n\ty44teTL+uC8V6EYvyZXI31R0BOSSeFKwvd62wRSA=","From":"Paul Elder ","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 24 May 2021 17:40:25 +0900","Message-Id":"<20210524084029.1179881-3-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.27.0","In-Reply-To":"<20210524084029.1179881-1-paul.elder@ideasonboard.com>","References":"<20210524084029.1179881-1-paul.elder@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[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":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Currently the generated constructors for structs defined in mojom files\nis being parsed by mojom. As the parameters are simply the struct\nmembers, they are already documented, and the documentation of the\nconstructor is pointless. Protect them against being parsed by doxygen.\n\nSigned-off-by: Paul Elder \n---\n .../generators/libcamera_templates/definition_functions.tmpl | 3 +++\n 1 file changed, 3 insertions(+)","diff":"diff --git a/utils/ipc/generators/libcamera_templates/definition_functions.tmpl b/utils/ipc/generators/libcamera_templates/definition_functions.tmpl\nindex 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 %}\n","prefixes":["libcamera-devel","RFC","2/6"]}