[libcamera-devel,v3,0/4] Improve libcamera documentation
mbox series

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

Message

Dan Scally Jan. 12, 2024, 12:14 p.m. UTC 
In this series the API split is achieved by collecting filepaths for "public"
sources in meson and passing them to a generated Doxyfile-public, which is then
included in the main Doxyfile. 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     |  21 +++++
 Documentation/Doxyfile-public.in       |   7 ++
 Documentation/Doxyfile.in              |  29 ++----
 Documentation/mainpage.dox             |  33 +++++++
 Documentation/meson.build              |  78 ++++++++++++++--
 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 +
 18 files changed, 376 insertions(+), 180 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