[libcamera-devel,0/5] libcamera: Miscellaneous documentation fixes
mbox series

Message ID 20201020000310.3008-1-laurent.pinchart@ideasonboard.com
Headers show
Series
  • libcamera: Miscellaneous documentation fixes
Related show

Message

Laurent Pinchart Oct. 20, 2020, 12:03 a.m. UTC 
Hello,

This small patch series fixes miscellaneous issues with doxygen. It
stems from the need to document the libcamera namespace with the latest
doxygen version (current master branch), which is done in patch 5/5.
Patches 1/5 to 4/5 fixes small issues uncovered by the libcamera
namespace being documented.

The only patch that I think may be need discussion is 2/5. Adding
#ifndef __DOXYGEN__ to all pipeline-specific IPA headers isn't very
nice, but there's no easy way to get doxygen to skip them. Listing the
files to be skipped explicitly to Doxyfile.in isn't great. Another
option would be to move those files to a separate directory, for
instance include/ipa/pipeline/, which can then be listed in Doxyfile.in.
Please let me know of your preference.

Laurent Pinchart (5):
  ipa: Rename ipa_vimc.h to vimc.h
  ipa: Skip doxygen parsing for pipeline-specific IPA headers
  libcamera: Place doxygen \file block above namespace
  libcamera: Drop semicolon after LOG_{DECLARE,DEFINE}_CATEGORY
  libcamera: Document the libcamera namespace

 include/libcamera/ipa/raspberrypi.h                   | 4 ++++
 include/libcamera/ipa/rkisp1.h                        | 4 ++++
 include/libcamera/ipa/{ipa_vimc.h => vimc.h}          | 6 +++++-
 src/ipa/vimc/vimc.cpp                                 | 2 +-
 src/libcamera/byte_stream_buffer.cpp                  | 8 ++++----
 src/libcamera/camera_manager.cpp                      | 3 +++
 src/libcamera/camera_sensor.cpp                       | 2 +-
 src/libcamera/file.cpp                                | 2 +-
 src/libcamera/pipeline/raspberrypi/staggered_ctrl.cpp | 2 +-
 src/libcamera/pipeline/simple/converter.cpp           | 2 +-
 src/libcamera/sysfs.cpp                               | 2 +-
 src/libcamera/v4l2_pixelformat.cpp                    | 1 +
 src/libcamera/v4l2_videodevice.cpp                    | 1 +
 test/ipa/ipa_interface_test.cpp                       | 2 +-
 14 files changed, 29 insertions(+), 12 deletions(-)
 rename include/libcamera/ipa/{ipa_vimc.h => vimc.h} (80%)