[libcamera-devel,0/2] Documentation: Quieten Doxygen
mbox series

Message ID 20190108132106.24906-1-kieran.bingham@ideasonboard.com
Headers show
Series
  • Documentation: Quieten Doxygen
Related show

Message

Kieran Bingham Jan. 8, 2019, 1:21 p.m. UTC
Presently Doxygen produces a lot of verbose output for all the files it
processes. This means that any warnings and errors are quite obfuscated
against the noise.

Set the Doxygen option QUIET to 'yes' which removes all output except
for warnings and errors.

I don't think we are yet keen on making Doxygen warnings build failure
errors though ?


The second patch is optional and certainly deserves some discussion.
Enabling parameter documentation warnings brings in a few extra across
pipeline/vimc.cpp, camera_manager.h, device_enumerator.h, log.h,
media_object.h, and pipeline_handler.h.

Should we enable this option and fixup these extra warning levels?


Kieran Bingham (2):
  Documentation: Suppress normal doxygen output
  [RFC] Documentation: Enable parameter documentation warnings

 Documentation/Doxyfile.in | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)