From patchwork Thu May 27 07:28:00 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Elder X-Patchwork-Id: 12437 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 061C1C3203 for ; Thu, 27 May 2021 07:28:19 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 7DE8968924; Thu, 27 May 2021 09:28:18 +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="rlBszDcp"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 55F2768920 for ; Thu, 27 May 2021 09:28:17 +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 D60C78DE; Thu, 27 May 2021 09:28:15 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1622100497; bh=5DCtvdKGlHAwOykXA18ubDDkuexop2CYOCpu9rkZICM=; h=From:To:Cc:Subject:Date:From; b=rlBszDcpXGxKy1oPkQ1BKzuEri97rWOrlffgx2e8ocnmE0o9ffivXt/47UNi4yEP+ KbztcTngF+rh1zRR/lh0Obsv/GluDE/9vGRM04syUCmKfR8b3t7CGIusQW9Phqu9RN EtZdc2amgSFWCG9NhYx+E1Jc9r5bts1ad0Ib1yuA= From: Paul Elder To: libcamera-devel@lists.libcamera.org Date: Thu, 27 May 2021 16:28:00 +0900 Message-Id: <20210527072805.1333870-1-paul.elder@ideasonboard.com> X-Mailer: git-send-email 2.27.0 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v3 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. In v3 I actually removed core_ipa_interface.cpp (I forgot to earlier :S) 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/core_ipa_interface.cpp | 199 ---------------------- src/libcamera/ipa/meson.build | 18 +- utils/ipc/extract-docs.py | 74 +++++++++ utils/ipc/meson.build | 2 + 7 files changed, 287 insertions(+), 219 deletions(-) delete mode 100644 src/libcamera/ipa/core_ipa_interface.cpp create mode 100755 utils/ipc/extract-docs.py Reviewed-by: Umang Jain