[libcamera-devel] [RFC PATCH 0/6] Generate docs from mojom files

Paul Elder paul.elder at ideasonboard.com
Mon May 24 10:40:23 CEST 2021


This patch series depends on v3 of "External IPU3 IPA Support".

This patch series enables generating documentation cpp files from mojom
files directly, so that we no longer need to manually put the comments
in cpp files directly.

The script (patch 1/6) simply extracts all comments that look like:
/**
anything
*/
and outputs that, along with a header and namespace libcamera {} to a
cpp files.

Patch 2/6 blocks struct constructors from being parsed by doxygen.

The rest of the patches plumb the documentation extractor and generation
through meson and core.mojom.

Paul Elder (6):
  utils: ipc: Add script to extract doxygen docs from mojom files
  utils: ipc: Prevent struct constructors from being parsed by doxygen
  meson: ipa: Use files() to locate the mojom files
  ipa: core: Move documentation from cpp file back into the mojom file
  meson: ipa: Pass core.mojom to the docs generator
  meson: ipa: Build documentation cpp files from mojom files

 Documentation/guides/ipa.rst                  |   6 +
 include/libcamera/ipa/core.mojom              | 200 +++++++++++++--
 include/libcamera/ipa/meson.build             |  13 +-
 src/libcamera/ipa/core_ipa_interface.cpp      | 237 ------------------
 src/libcamera/ipa/meson.build                 |  18 +-
 utils/ipc/extract-docs.py                     |  77 ++++++
 .../definition_functions.tmpl                 |   3 +
 utils/ipc/meson.build                         |   2 +
 8 files changed, 295 insertions(+), 261 deletions(-)
 delete mode 100644 src/libcamera/ipa/core_ipa_interface.cpp
 create mode 100755 utils/ipc/extract-docs.py

-- 
2.27.0



More information about the libcamera-devel mailing list