ipa: Skip doxygen parsing for pipeline-specific IPA headers

The pipeline-specific IPA headers are not part of the libcamera API,
they should thus be skipped when generating documentation. doxygen
doesn't complain currently due to the fact that types defined in those
headers are part of undocumented namespaces. In preparation for
documenting the libcamera namespace, make sure the headers don't get
parsed by doxygen.

Only vimc.h needs a header guard, as rkisp1.h uses the global namespace
and raspberrypi.h uses the undocumented libcamera::RPi namespace,
neither of which cause issues. Still, for consistency, add header guards
to all headers.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
This commit is contained in:
Laurent Pinchart
2020-10-20 02:20:02 +03:00
parent 00aa3ac82e
commit 3fe0edc989
3 changed files with 12 additions and 0 deletions

View File

@@ -10,6 +10,8 @@
#include <libcamera/control_ids.h>
#include <libcamera/controls.h>
#ifndef __DOXYGEN__
namespace libcamera {
namespace RPi {
@@ -66,4 +68,6 @@ static const ControlInfoMap Controls = {
} /* namespace libcamera */
#endif /* __DOXYGEN__ */
#endif /* __LIBCAMERA_IPA_INTERFACE_RASPBERRYPI_H__ */

View File

@@ -7,6 +7,8 @@
#ifndef __LIBCAMERA_IPA_INTERFACE_RKISP1_H__
#define __LIBCAMERA_IPA_INTERFACE_RKISP1_H__
#ifndef __DOXYGEN__
enum RkISP1Operations {
RKISP1_IPA_ACTION_V4L2_SET = 1,
RKISP1_IPA_ACTION_PARAM_FILLED = 2,
@@ -15,4 +17,6 @@ enum RkISP1Operations {
RKISP1_IPA_EVENT_QUEUE_REQUEST = 5,
};
#endif /* __DOXYGEN__ */
#endif /* __LIBCAMERA_IPA_INTERFACE_RKISP1_H__ */

View File

@@ -8,6 +8,8 @@
#ifndef __LIBCAMERA_IPA_VIMC_H__
#define __LIBCAMERA_IPA_VIMC_H__
#ifndef __DOXYGEN__
namespace libcamera {
#define VIMC_IPA_FIFO_PATH "/tmp/libcamera_ipa_vimc_fifo"
@@ -21,4 +23,6 @@ enum IPAOperationCode {
} /* namespace libcamera */
#endif /* __DOXYGEN__ */
#endif /* __LIBCAMERA_IPA_VIMC_H__ */