[libcamera-devel,v2,3/8] Documentation: Exclude pipeline handlers directory
diff mbox series

Message ID 20190115151849.1547-4-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Pipeline handler refactoring and assorted improvements
Related show

Commit Message

Laurent Pinchart Jan. 15, 2019, 3:18 p.m. UTC 
The pipeline handlers don't define APIs, neither public not internal.
There is thus no need to generate Doxygen documentation from thoses
classes. Add them to the EXCLUDE files pattern.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
---
 Documentation/Doxyfile.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Niklas Söderlund Jan. 15, 2019, 10:22 p.m. UTC | #1 
Hi Laurent,

Thanks for your work.

On 2019-01-15 17:18:44 +0200, Laurent Pinchart wrote:
> The pipeline handlers don't define APIs, neither public not internal.
> There is thus no need to generate Doxygen documentation from thoses
> classes. Add them to the EXCLUDE files pattern.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> ---
>  Documentation/Doxyfile.in | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index 5c0d87baac9c..dd74b7295d50 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -833,7 +833,7 @@ RECURSIVE              = YES
>  # Note that relative paths are relative to the directory from which doxygen is
>  # run.
>  
> -EXCLUDE                =
> +EXCLUDE                = ../src/libcamera/pipeline/
>  
>  # 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
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Patch
diff mbox series 

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index 5c0d87baac9c..dd74b7295d50 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -833,7 +833,7 @@  RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = ../src/libcamera/pipeline/
 
 # 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