[libcamera-devel,10/38] Documentation: skip generating documentation for generated code

Message ID 20200922133537.258098-11-paul.elder@ideasonboard.com
State Superseded
Headers show
Series
  • IPA isolation implementation
Related show

Commit Message

Paul Elder Sept. 22, 2020, 1:35 p.m. UTC
Specify in doxygen to not generate code for the generated headers and
proxy source code files.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>

---
New in v2
---
 Documentation/Doxyfile.in | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Laurent Pinchart Sept. 29, 2020, 4:01 a.m. UTC | #1
Hi Paul,

Thank you for the patch.

On Tue, Sep 22, 2020 at 10:35:09PM +0900, Paul Elder wrote:
> Specify in doxygen to not generate code for the generated headers and
> proxy source code files.
> 
> Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
> New in v2
> ---
>  Documentation/Doxyfile.in | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index fa8d744b..598eca9b 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -840,7 +840,9 @@ EXCLUDE                = @TOP_SRCDIR@/include/libcamera/span.h \
>  			 @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \
>  			 @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \
>  			 @TOP_SRCDIR@/src/libcamera/pipeline/ \
> -			 @TOP_SRCDIR@/src/libcamera/proxy/
> +			 @TOP_SRCDIR@/src/libcamera/proxy/ \
> +			 @TOP_BUILDDIR@/include/libcamera/ipa/ \
> +			 @TOP_BUILDDIR@/src/libcamera/proxy/
>  
>  # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
>  # directories that are symbolic links (a Unix file system feature) are excluded

Patch

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index fa8d744b..598eca9b 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -840,7 +840,9 @@  EXCLUDE                = @TOP_SRCDIR@/include/libcamera/span.h \
 			 @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \
 			 @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \
 			 @TOP_SRCDIR@/src/libcamera/pipeline/ \
-			 @TOP_SRCDIR@/src/libcamera/proxy/
+			 @TOP_SRCDIR@/src/libcamera/proxy/ \
+			 @TOP_BUILDDIR@/include/libcamera/ipa/ \
+			 @TOP_BUILDDIR@/src/libcamera/proxy/
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded