{"id":20822,"url":"https://patchwork.libcamera.org/api/1.1/covers/20822/?format=json","web_url":"https://patchwork.libcamera.org/cover/20822/","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":"<20240807154410.9552-1-laurent.pinchart@ideasonboard.com>","date":"2024-08-07T15:44:05","name":"[v6,0/5] Split libcamera documentation in public and internal APIs","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"mbox":"https://patchwork.libcamera.org/cover/20822/mbox/","series":[{"id":4497,"url":"https://patchwork.libcamera.org/api/1.1/series/4497/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4497","date":"2024-08-07T15:44:05","name":"Split libcamera documentation in public and internal APIs","version":6,"mbox":"https://patchwork.libcamera.org/series/4497/mbox/"}],"comments":"https://patchwork.libcamera.org/api/covers/20822/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 A0CACC323E\n\tfor ;\n\tWed, 7 Aug 2024 15:44:35 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 8A00A6338D;\n\tWed, 7 Aug 2024 17:44:34 +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 84F4B6337E\n\tfor ;\n\tWed, 7 Aug 2024 17:44:33 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 66B2C6AF\n\tfor ;\n\tWed, 7 Aug 2024 17:43:40 +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=\"GnM2FHK2\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723045420;\n\tbh=dvrJFeqiA60bAE0ycXFUZXWgE0DjQgS3f13ecGYoOK4=;\n\th=From:To:Subject:Date:From;\n\tb=GnM2FHK2RtegMKiwYPPDOttfc23PrFkr0Rsy9CHbmOAvRTPRENj2y7ojhUZ/uSAMP\n\tkT31EfKD+Fap21GWY/d104ysGJlCIAmWO7cxulWrBlrOsXkPDkiVqmNNLrjljjqtcV\n\tDdFCWmb+PJbaPfGL0tRf/WnAid7ypWD4ptTcrE+0=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH v6 0/5] Split libcamera documentation in public and internal\n\tAPIs","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","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\nCompared to v5, I've addressed all review comments, and replaced patch\n1/5 with the latest version from Dan. The 13 first patches of v5 have\nbeen merged already, substantially reducing the size of this series.\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 | 82 ++++++++++++++++---\n Documentation/thread-safety.dox | 40 +++++++++\n src/libcamera/base/thread.cpp | 36 --------\n src/libcamera/camera.cpp | 1 +\n 9 files changed, 241 insertions(+), 72 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\n\n\nbase-commit: 93506de63af7fa94c458c359101ac0f4b99e8fc6"}