diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2020-10-20 02:20:02 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2020-10-20 13:19:45 +0300 |
| commit | 3fe0edc989e5db38666d435fea4ad91a9fdfe266 (patch) | |
| tree | 24da75cb519f82dd4b255d55233438c1de9298d3 | |
| parent | 00aa3ac82ed0bc7d49f3235bec2991a647de3529 (diff) | |
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>
| -rw-r--r-- | include/libcamera/ipa/raspberrypi.h | 4 | ||||
| -rw-r--r-- | include/libcamera/ipa/rkisp1.h | 4 | ||||
| -rw-r--r-- | include/libcamera/ipa/vimc.h | 4 |
3 files changed, 12 insertions, 0 deletions
diff --git a/include/libcamera/ipa/raspberrypi.h b/include/libcamera/ipa/raspberrypi.h index b3041591..b23baf2f 100644 --- a/include/libcamera/ipa/raspberrypi.h +++ b/include/libcamera/ipa/raspberrypi.h @@ -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__ */ diff --git a/include/libcamera/ipa/rkisp1.h b/include/libcamera/ipa/rkisp1.h index 4fe0482b..bb824f29 100644 --- a/include/libcamera/ipa/rkisp1.h +++ b/include/libcamera/ipa/rkisp1.h @@ -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__ */ diff --git a/include/libcamera/ipa/vimc.h b/include/libcamera/ipa/vimc.h index 22d97992..27a4a61d 100644 --- a/include/libcamera/ipa/vimc.h +++ b/include/libcamera/ipa/vimc.h @@ -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__ */ |