{"id":12404,"url":"https://patchwork.libcamera.org/api/1.1/covers/12404/?format=json","web_url":"https://patchwork.libcamera.org/cover/12404/","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":"<20210525095218.1237140-1-paul.elder@ideasonboard.com>","date":"2021-05-25T09:52:13","name":"[libcamera-devel,v2,0/5] Generate docs from mojom files","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/1.1/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"mbox":"https://patchwork.libcamera.org/cover/12404/mbox/","series":[{"id":2064,"url":"https://patchwork.libcamera.org/api/1.1/series/2064/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2064","date":"2021-05-25T09:52:13","name":"Generate docs from mojom files","version":2,"mbox":"https://patchwork.libcamera.org/series/2064/mbox/"}],"comments":"https://patchwork.libcamera.org/api/covers/12404/comments/","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 92D3FC3202\n\tfor ;\n\tTue, 25 May 2021 09:52:37 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 1468E6891F;\n\tTue, 25 May 2021 11:52:37 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 442F5602AF\n\tfor ;\n\tTue, 25 May 2021 11:52:35 +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 4E9D9344;\n\tTue, 25 May 2021 11:52:33 +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=\"RWv3mT7C\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1621936354;\n\tbh=3RNQPxjkyJJZzC7bS4ZmqBFQWFr8ct3Vg/Rq9gIEYpY=;\n\th=From:To:Cc:Subject:Date:From;\n\tb=RWv3mT7CwM87UB3DgA52XGLNpI+B1QfV5LtWXAoEzO8Y4XMXhMZn3NHhjneYnb8H7\n\tuWUeyaVsHeaZf76g4saToCa92Tpj5jh6sbH7dIXhSSc88qe4/nzmamDdpCICxsRjTH\n\tS8XrW05Q5HsNSewo0C+rltHe7aMgh8C7NyfjPGbw=","From":"Paul Elder ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 25 May 2021 18:52:13 +0900","Message-Id":"<20210525095218.1237140-1-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.27.0","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v2 0/5] Generate docs from mojom files","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":"This patch series enables generating documentation cpp files from mojom\nfiles directly, so that we no longer need to manually put the comments\nin cpp files directly.\n\nThe script (patch 1/5) simply extracts all comments that look like:\n/**\nanything\n*/\nand outputs that, along with a header and namespace libcamera {} to a\ncpp files.\n\nThe rest of the patches plumb the documentation extractor and generation\nthrough meson and core.mojom.\n\nNot much has changed in v2, except that the dependent patch series has\nbeen pushed to master so this series has been rebased on that.\n\nPaul Elder (5):\n utils: ipc: Add script to extract doxygen docs from mojom files\n meson: ipa: Use files() to locate the mojom files\n ipa: core: Move documentation from cpp file back into the mojom file\n meson: ipa: Pass core.mojom to the docs generator\n meson: ipa: Build documentation cpp files from mojom files\n\n Documentation/guides/ipa.rst | 6 +\n include/libcamera/ipa/core.mojom | 200 +++++++++++++++++++++++++++---\n include/libcamera/ipa/meson.build | 7 +-\n src/libcamera/ipa/meson.build | 18 ++-\n utils/ipc/extract-docs.py | 74 +++++++++++\n utils/ipc/meson.build | 2 +\n 6 files changed, 287 insertions(+), 20 deletions(-)\n create mode 100755 utils/ipc/extract-docs.py"}