[libcamera-devel,v2,0/5] Improve libcamera documentation
mbox series

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

Message

Dan Scally Jan. 5, 2024, 4:40 p.m. UTC 
Hello all

This series combines my three recent patches splitting Documentation into a
public and internal API run and improving on the currently-empty main page. In
version two 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 (5):
  libcamera: geometry: Correct doxygen reference to classes
  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       |   5 +
 Documentation/Doxyfile.in              |  29 ++----
 Documentation/libcamera.dox            |  33 +++++++
 Documentation/meson.build              |  78 ++++++++++++++--
 Documentation/thread.dox               | 122 ++++++++++++++++++++++++
 include/libcamera/base/meson.build     |   9 +-
 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/geometry.cpp             |   8 +-
 src/libcamera/meson.build              |  43 ++++++---
 src/libcamera/request.cpp              |   1 +
 19 files changed, 379 insertions(+), 185 deletions(-)
 create mode 100644 Documentation/Doxyfile-internal.in
 create mode 100644 Documentation/Doxyfile-public.in
 create mode 100644 Documentation/libcamera.dox
 create mode 100644 Documentation/thread.dox