[v6,0/5] Split libcamera documentation in public and internal APIs
mbox series

Message ID 20240807154410.9552-1-laurent.pinchart@ideasonboard.com
Headers show
Series
  • Split libcamera documentation in public and internal APIs
Related show

Message

Laurent Pinchart Aug. 7, 2024, 3:44 p.m. UTC 
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.

Compared to v5, I've addressed all review comments, and replaced patch
1/5 with the latest version from Dan. The 13 first patches of v5 have
been merged already, substantially reducing the size of this series.

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                     | 82 ++++++++++++++++---
 Documentation/thread-safety.dox               | 40 +++++++++
 src/libcamera/base/thread.cpp                 | 36 --------
 src/libcamera/camera.cpp                      |  1 +
 9 files changed, 241 insertions(+), 72 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


base-commit: 93506de63af7fa94c458c359101ac0f4b99e8fc6