From patchwork Wed Aug 7 15:44:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 20822 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 A0CACC323E for ; Wed, 7 Aug 2024 15:44:35 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 8A00A6338D; Wed, 7 Aug 2024 17:44:34 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="GnM2FHK2"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 84F4B6337E for ; Wed, 7 Aug 2024 17:44:33 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 66B2C6AF for ; Wed, 7 Aug 2024 17:43:40 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1723045420; bh=dvrJFeqiA60bAE0ycXFUZXWgE0DjQgS3f13ecGYoOK4=; h=From:To:Subject:Date:From; b=GnM2FHK2RtegMKiwYPPDOttfc23PrFkr0Rsy9CHbmOAvRTPRENj2y7ojhUZ/uSAMP kT31EfKD+Fap21GWY/d104ysGJlCIAmWO7cxulWrBlrOsXkPDkiVqmNNLrjljjqtcV DdFCWmb+PJbaPfGL0tRf/WnAid7ypWD4ptTcrE+0= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH v6 0/5] Split libcamera documentation in public and internal APIs Date: Wed, 7 Aug 2024 18:44:05 +0300 Message-ID: <20240807154410.9552-1-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.44.2 MIME-Version: 1.0 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" Hello, This series aims to improve the libcamera API documentation a little by adding some content to the landing page and splitting it to two separate outputs for the library's users and developers. The "public" run, intended for users, is a much abridged version that only documents those objects intended to be used by application developers. The split is achieved by collecting file paths for public sources in meson and passing them to a generated Doxyfile-public, which is used for the "public" run of Doxygen. A second Doxyfile-internal retains the current behaviour for the internal API run. Compared to v5, I've addressed all review comments, and replaced patch 1/5 with the latest version from Dan. The 13 first patches of v5 have been merged already, substantially reducing the size of this series. Daniel Scally (3): Documentation: Add Thread safety page Documentation: Split public/private documentation Documentation: Improve doxygen main page Laurent Pinchart (2): Documentation: Split doxygen_input in public and internal inputs libcamera: camera: Hide Camera::create() from the public API .../{Doxyfile.in => Doxyfile-common.in} | 24 +----- Documentation/Doxyfile-internal.in | 31 +++++++ Documentation/Doxyfile-public.in | 20 +++++ Documentation/gen-doxyfile.py | 46 +++++++++++ Documentation/mainpage.dox | 33 ++++++++ Documentation/meson.build | 82 ++++++++++++++++--- Documentation/thread-safety.dox | 40 +++++++++ src/libcamera/base/thread.cpp | 36 -------- src/libcamera/camera.cpp | 1 + 9 files changed, 241 insertions(+), 72 deletions(-) rename Documentation/{Doxyfile.in => Doxyfile-common.in} (63%) create mode 100644 Documentation/Doxyfile-internal.in create mode 100644 Documentation/Doxyfile-public.in create mode 100755 Documentation/gen-doxyfile.py create mode 100644 Documentation/mainpage.dox create mode 100644 Documentation/thread-safety.dox base-commit: 93506de63af7fa94c458c359101ac0f4b99e8fc6