From patchwork Thu Aug 8 14:09:43 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20839 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 13C06C323E for ; Thu, 8 Aug 2024 14:10:08 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id C6BB7633B4; Thu, 8 Aug 2024 16:10:06 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="kVacw6h3"; 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 B084561955 for ; Thu, 8 Aug 2024 16:10:04 +0200 (CEST) Received: from mail.ideasonboard.com (cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id C2DCA13D7; Thu, 8 Aug 2024 16:09:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1723126150; bh=tSRp0bQujumzHdtN2X30JzV49sowBpp8qHkfnQvEMjQ=; h=From:To:Cc:Subject:Date:From; b=kVacw6h3SPNUEFOJtG4QjcGdoGRn4UJ06xolvxhU1ZWljnnO42lUgAJagQu0vY3PH zDZ5IHLmWsOoXf865PVuzKifvW8G7JXqu3VxZY2VQp5ecJJ+EddtcOoYlRtdQrVNeF uyk9g7ya+BukhGpvwuuuMDraR/kCRIBiQ4YaHK4M= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH v7 0/5] Split libcamera documentation in public and internal APIs Date: Thu, 8 Aug 2024 15:09:43 +0100 Message-Id: <20240808140948.430419-1-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 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. This v7 updates patch 1 to account for comments from Laurent in v5 and then addresses some knock-on effects to the other patches in the series. Dan 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 | 80 ++++++++++++++++--- Documentation/thread-safety.dox | 48 +++++++++++ src/libcamera/base/thread.cpp | 36 --------- src/libcamera/camera.cpp | 1 + 9 files changed, 248 insertions(+), 71 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