From patchwork Fri Jan 5 16:40:59 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 19371 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 541F6C323E for ; Fri, 5 Jan 2024 16:41:24 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 5C62362B54; Fri, 5 Jan 2024 17:41:23 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1704472883; bh=3V8gp+bKJgQ4uKxevd9KEC8fHFcDs6naG3d8UOJVmik=; h=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=HMJxrf/Vwu5bdZIELTMgOlSCzqk2YQUgH1paa9BIuheKD6/ZUURsj/4/yFHwJrgjp IJcqTHgiZQVm5rbKvX+6sRHB1mMgWCiX/P61+Bi4y9SWXhewPS2AgLKPJcSKsPV7oo GjBLsQvQR694SLmE1lm3BO/GvbsqGB4MDwnwWZpJgooGd53RuRKOP9FR3pH8wwVwnt Z8vqScQs0VCDDQ/PPKDUile8heufiQT4o+e8b+6LeDLR70wPNLxiCgFC6Bmq8hNdfU BQh7UdONQMrY+zJsfxFCPFMAXoToIyVIaSNY62Sqb20zdh6pGGK7WhcpCw51gmcV4W 7kHGXJY9Hc6gw== 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 A943161D7F for ; Fri, 5 Jan 2024 17:41:21 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="LAGem9Uo"; dkim-atps=neutral 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 EBEB8720; Fri, 5 Jan 2024 17:40:19 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1704472820; bh=3V8gp+bKJgQ4uKxevd9KEC8fHFcDs6naG3d8UOJVmik=; h=From:To:Cc:Subject:Date:From; b=LAGem9UoDppAvdl2uWKPF2AWPrRgzigsrvNa+fSWtE7HPIGKaPRO5xWrbR/K0sHUf DqXJBCFjpLZOMFO5ZUMDj7ehxR5FyFGPzIjb2nJ7lTeKqe/FEd4BWYj3+Wm3SO5cWv h6lEmqb0rokyNQnn5m+qZNIut06oHuvyTqcs+L58= To: libcamera-devel@lists.libcamera.org Date: Fri, 5 Jan 2024 16:40:59 +0000 Message-Id: <20240105164104.78398-1-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2 0/5] Improve libcamera documentation 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: , X-Patchwork-Original-From: Daniel Scally via libcamera-devel From: Dan Scally Reply-To: Daniel Scally Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Hello all This series combines my three recent patches splitting Documentation into a public and internal API run and improving on the currently-empty main page. In version two the API split is achieved by collecting filepaths for "public" sources in meson and passing them to a generated Doxyfile-public, which is then included in the main Doxyfile. A second Doxyfile-internal retains the current behaviour for the internal API run. Thanks Dan Daniel Scally (5): libcamera: geometry: Correct doxygen reference to classes 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 | 21 +++++ Documentation/Doxyfile-public.in | 5 + Documentation/Doxyfile.in | 29 ++---- Documentation/libcamera.dox | 33 +++++++ Documentation/meson.build | 78 ++++++++++++++-- Documentation/thread.dox | 122 ++++++++++++++++++++++++ include/libcamera/base/meson.build | 9 +- 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/geometry.cpp | 8 +- src/libcamera/meson.build | 43 ++++++--- src/libcamera/request.cpp | 1 + 19 files changed, 379 insertions(+), 185 deletions(-) create mode 100644 Documentation/Doxyfile-internal.in create mode 100644 Documentation/Doxyfile-public.in create mode 100644 Documentation/libcamera.dox create mode 100644 Documentation/thread.dox