{"id":20839,"url":"https://patchwork.libcamera.org/api/1.1/covers/20839/?format=json","web_url":"https://patchwork.libcamera.org/cover/20839/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20240808140948.430419-1-dan.scally@ideasonboard.com>","date":"2024-08-08T14:09:43","name":"[v7,0/5] Split libcamera documentation in public and internal APIs","submitter":{"id":156,"url":"https://patchwork.libcamera.org/api/1.1/people/156/?format=json","name":"Dan Scally","email":"dan.scally@ideasonboard.com"},"mbox":"https://patchwork.libcamera.org/cover/20839/mbox/","series":[{"id":4502,"url":"https://patchwork.libcamera.org/api/1.1/series/4502/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4502","date":"2024-08-08T14:09:43","name":"Split libcamera documentation in public and internal APIs","version":7,"mbox":"https://patchwork.libcamera.org/series/4502/mbox/"}],"comments":"https://patchwork.libcamera.org/api/covers/20839/comments/","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 13C06C323E\n\tfor ;\n\tThu, 8 Aug 2024 14:10:08 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C6BB7633B4;\n\tThu, 8 Aug 2024 16:10:06 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id B084561955\n\tfor ;\n\tThu, 8 Aug 2024 16:10:04 +0200 (CEST)","from mail.ideasonboard.com\n\t(cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C2DCA13D7;\n\tThu, 8 Aug 2024 16:09:10 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"kVacw6h3\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723126150;\n\tbh=tSRp0bQujumzHdtN2X30JzV49sowBpp8qHkfnQvEMjQ=;\n\th=From:To:Cc:Subject:Date:From;\n\tb=kVacw6h3SPNUEFOJtG4QjcGdoGRn4UJ06xolvxhU1ZWljnnO42lUgAJagQu0vY3PH\n\tzDZ5IHLmWsOoXf865PVuzKifvW8G7JXqu3VxZY2VQp5ecJJ+EddtcOoYlRtdQrVNeF\n\tuyk9g7ya+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\n\tAPIs","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","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Hello,\n\nThis series aims to improve the libcamera API documentation a little by\nadding some content to the landing page and splitting it to two separate\noutputs for the library's users and developers. The \"public\" run,\nintended for users, is a much abridged version that only documents those\nobjects intended to be used by application developers.\n\nThe split is achieved by collecting file paths for public sources in\nmeson and passing them to a generated Doxyfile-public, which is used for\nthe \"public\" run of Doxygen. A second Doxyfile-internal retains the\ncurrent behaviour for the internal API run.\n\nThis v7 updates patch 1 to account for comments from Laurent in v5 and then\naddresses some knock-on effects to the other patches in the series.\n\nDan\n\nDaniel Scally (3):\n Documentation: Add Thread safety page\n Documentation: Split public/private documentation\n Documentation: Improve doxygen main page\n\nLaurent Pinchart (2):\n Documentation: Split doxygen_input in public and internal inputs\n libcamera: camera: Hide Camera::create() from the public API\n\n .../{Doxyfile.in => Doxyfile-common.in} | 24 +-----\n Documentation/Doxyfile-internal.in | 31 +++++++\n Documentation/Doxyfile-public.in | 20 +++++\n Documentation/gen-doxyfile.py | 46 +++++++++++\n Documentation/mainpage.dox | 33 ++++++++\n Documentation/meson.build | 80 ++++++++++++++++---\n Documentation/thread-safety.dox | 48 +++++++++++\n src/libcamera/base/thread.cpp | 36 ---------\n src/libcamera/camera.cpp | 1 +\n 9 files changed, 248 insertions(+), 71 deletions(-)\n rename Documentation/{Doxyfile.in => Doxyfile-common.in} (63%)\n create mode 100644 Documentation/Doxyfile-internal.in\n create mode 100644 Documentation/Doxyfile-public.in\n create mode 100755 Documentation/gen-doxyfile.py\n create mode 100644 Documentation/mainpage.dox\n create mode 100644 Documentation/thread-safety.dox"}