[PATCH v7 0/5] Split libcamera documentation in public and internal APIs

Daniel Scally dan.scally at ideasonboard.com
Thu Aug 8 16:09:43 CEST 2024


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

-- 
2.34.1



More information about the libcamera-devel mailing list