[libcamera-devel,v4,18/19] Documentation: Include IPU3 in Doxygen build
diff mbox series

Message ID 20211026095534.90348-19-jeanmichel.hautbois@ideasonboard.com
State Superseded
Headers show
Series
  • Document IPU3 IPA
Related show

Commit Message

Jean-Michel Hautbois Oct. 26, 2021, 9:55 a.m. UTC
From: Kieran Bingham <kieran.bingham@ideasonboard.com>

The IPU3 is documented using Doxygen within the code.

Include the IPU3 IPA as part of the doxygen build sources. This will
ideally be split to its own 'section' of the doxygen output.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/Doxyfile.in | 3 ++-
 Documentation/meson.build | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

Comments

Laurent Pinchart Oct. 26, 2021, 10:12 a.m. UTC | #1
On Tue, Oct 26, 2021 at 11:55:33AM +0200, Jean-Michel Hautbois wrote:
> From: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> The IPU3 is documented using Doxygen within the code.
> 
> Include the IPU3 IPA as part of the doxygen build sources. This will
> ideally be split to its own 'section' of the doxygen output.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com>
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/Doxyfile.in | 3 ++-
>  Documentation/meson.build | 1 +
>  2 files changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 6e627192..28605b8f 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -788,7 +788,8 @@ WARN_LOGFILE           =
>  # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
>  # Note: If this tag is empty the current directory is searched.
>  
> -INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
> +INPUT                  = "@TOP_SRCDIR@/src/ipa/ipu3" \
> +                         "@TOP_SRCDIR@/include/libcamera" \

src/ goes after include/

>  			 "@TOP_SRCDIR@/src/ipa/libipa" \
>  			 "@TOP_SRCDIR@/src/libcamera" \
>  			 "@TOP_BUILDDIR@/include/libcamera" \
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index c4bd3c7f..df36a808 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -22,6 +22,7 @@ if doxygen.found() and dot.found()
>      custom_target('doxygen',
>                    input : [
>                        doxyfile,
> +                      ipu3_ipa_sources,
>                        libcamera_base_headers,
>                        libcamera_base_sources,
>                        libcamera_internal_headers,

Patch
diff mbox series

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index 6e627192..28605b8f 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -788,7 +788,8 @@  WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = "@TOP_SRCDIR@/include/libcamera" \
+INPUT                  = "@TOP_SRCDIR@/src/ipa/ipu3" \
+                         "@TOP_SRCDIR@/include/libcamera" \
 			 "@TOP_SRCDIR@/src/ipa/libipa" \
 			 "@TOP_SRCDIR@/src/libcamera" \
 			 "@TOP_BUILDDIR@/include/libcamera" \
diff --git a/Documentation/meson.build b/Documentation/meson.build
index c4bd3c7f..df36a808 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -22,6 +22,7 @@  if doxygen.found() and dot.found()
     custom_target('doxygen',
                   input : [
                       doxyfile,
+                      ipu3_ipa_sources,
                       libcamera_base_headers,
                       libcamera_base_sources,
                       libcamera_internal_headers,