From patchwork Tue May 25 09:52:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Elder X-Patchwork-Id: 12404 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 92D3FC3202 for ; Tue, 25 May 2021 09:52:37 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 1468E6891F; Tue, 25 May 2021 11:52:37 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="RWv3mT7C"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 442F5602AF for ; Tue, 25 May 2021 11:52:35 +0200 (CEST) Received: from pyrite.rasen.tech (unknown [IPv6:2400:4051:61:600:2c71:1b79:d06d:5032]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 4E9D9344; Tue, 25 May 2021 11:52:33 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1621936354; bh=3RNQPxjkyJJZzC7bS4ZmqBFQWFr8ct3Vg/Rq9gIEYpY=; h=From:To:Cc:Subject:Date:From; b=RWv3mT7CwM87UB3DgA52XGLNpI+B1QfV5LtWXAoEzO8Y4XMXhMZn3NHhjneYnb8H7 uWUeyaVsHeaZf76g4saToCa92Tpj5jh6sbH7dIXhSSc88qe4/nzmamDdpCICxsRjTH S8XrW05Q5HsNSewo0C+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 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: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" This patch series enables generating documentation cpp files from mojom files directly, so that we no longer need to manually put the comments in cpp files directly. The script (patch 1/5) simply extracts all comments that look like: /** anything */ and outputs that, along with a header and namespace libcamera {} to a cpp files. The rest of the patches plumb the documentation extractor and generation through meson and core.mojom. Not much has changed in v2, except that the dependent patch series has been pushed to master so this series has been rebased on that. Paul Elder (5): utils: ipc: Add script to extract doxygen docs from mojom files meson: ipa: Use files() to locate the mojom files ipa: core: Move documentation from cpp file back into the mojom file meson: ipa: Pass core.mojom to the docs generator meson: ipa: Build documentation cpp files from mojom files Documentation/guides/ipa.rst | 6 + include/libcamera/ipa/core.mojom | 200 +++++++++++++++++++++++++++--- include/libcamera/ipa/meson.build | 7 +- src/libcamera/ipa/meson.build | 18 ++- utils/ipc/extract-docs.py | 74 +++++++++++ utils/ipc/meson.build | 2 + 6 files changed, 287 insertions(+), 20 deletions(-) create mode 100755 utils/ipc/extract-docs.py Reviewed-by: Laurent Pinchart Reviewed-by: Umang Jain Reviewed-by: Umang Jain