From patchwork Wed Jul 31 13:51:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20724 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 E3A36C323E for ; Wed, 31 Jul 2024 13:52:19 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id EA6456337B; Wed, 31 Jul 2024 15:52:18 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="t9L6KT6M"; 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 D71086198E for ; Wed, 31 Jul 2024 15:52:16 +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 E33E6F85; Wed, 31 Jul 2024 15:51:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1722433889; bh=cL83MJzhKHcZdBarG3zJqk/6B/IdOjfmDjwkYb5qWes=; h=From:To:Cc:Subject:Date:From; b=t9L6KT6MPtuNwlVDHUEJzjDQfQTQfg67HeY8UDtIJuouaMulK8dBhbn0SKBwtcAhz ZAFkKi4CFdyqWGa452GVOhjEqN6QrzHr9sXPmwUMAUU/SSEALhZZ0sThOjT19n+ZW1 Jkkc/igjlokLXodkTadwpwGlaYL9j3K2DR4nQnnc= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH v4 0/4] Improve libcamera documentation Date: Wed, 31 Jul 2024 14:51:57 +0100 Message-Id: <20240731135201.2866145-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 all 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 fileoaths 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. Thanks Dan Daniel Scally (4): meson: libcamera: Split public and internal source arrays Documentation: Add Thread support page libcamera: Documentation: Split public/private documentation libcamera: Documentation: Improve doxygen main page Documentation/Doxyfile-internal.in | 31 +++++++ Documentation/Doxyfile-public.in | 15 +++ Documentation/Doxyfile.in | 23 +---- Documentation/mainpage.dox | 33 +++++++ Documentation/meson.build | 48 +++++++++- Documentation/thread.dox | 122 ++++++++++++++++++++++++ include/libcamera/base/meson.build | 7 ++ include/libcamera/internal/meson.build | 28 +++++- include/libcamera/meson.build | 10 ++ meson.build | 8 ++ src/libcamera/base/class.cpp | 1 + src/libcamera/base/meson.build | 31 +++++-- src/libcamera/base/thread.cpp | 123 ------------------------- src/libcamera/camera.cpp | 7 ++ src/libcamera/camera_manager.cpp | 1 + src/libcamera/framebuffer.cpp | 6 +- src/libcamera/meson.build | 43 ++++++--- src/libcamera/request.cpp | 1 + src/libcamera/sensor/meson.build | 5 + 19 files changed, 365 insertions(+), 178 deletions(-) create mode 100644 Documentation/Doxyfile-internal.in create mode 100644 Documentation/Doxyfile-public.in create mode 100644 Documentation/mainpage.dox create mode 100644 Documentation/thread.dox