[v4,0/4] Improve libcamera documentation
mbox series

Message ID 20240731135201.2866145-1-dan.scally@ideasonboard.com
Headers show
Series
  • Improve libcamera documentation
Related show

Message

Dan Scally July 31, 2024, 1:51 p.m. UTC 
Hello all

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 fileoaths 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.

Thanks
Dan

Daniel Scally (4):
  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     |  31 +++++++
 Documentation/Doxyfile-public.in       |  15 +++
 Documentation/Doxyfile.in              |  23 +----
 Documentation/mainpage.dox             |  33 +++++++
 Documentation/meson.build              |  48 +++++++++-
 Documentation/thread.dox               | 122 ++++++++++++++++++++++++
 include/libcamera/base/meson.build     |   7 ++
 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/meson.build              |  43 ++++++---
 src/libcamera/request.cpp              |   1 +
 src/libcamera/sensor/meson.build       |   5 +
 19 files changed, 365 insertions(+), 178 deletions(-)
 create mode 100644 Documentation/Doxyfile-internal.in
 create mode 100644 Documentation/Doxyfile-public.in
 create mode 100644 Documentation/mainpage.dox
 create mode 100644 Documentation/thread.dox