[libcamera-devel] Documentation: Drop deprecated Doxygen options
diff mbox series

Message ID 20210817223338.9027-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit e991bb2c362e5dc2e9fdea2410e74c39a39d8708
Headers show
Series
  • [libcamera-devel] Documentation: Drop deprecated Doxygen options
Related show

Commit Message

Laurent Pinchart Aug. 17, 2021, 10:33 p.m. UTC
The Doxygen LATEX_SOURCE_CODE, RTF_SOURCE_CODE and
DOCBOOK_PROGRAMLISTING options are deprecated, and generate warnings
with the Doxygen's master branch. Drop them.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/Doxyfile.in | 29 -----------------------------
 1 file changed, 29 deletions(-)

Comments

Kieran Bingham Aug. 18, 2021, 8:42 a.m. UTC | #1
Hi Laurent,

On 17/08/2021 23:33, Laurent Pinchart wrote:
> The Doxygen LATEX_SOURCE_CODE, RTF_SOURCE_CODE and
> DOCBOOK_PROGRAMLISTING options are deprecated, and generate warnings
> with the Doxygen's master branch. Drop them.

And they were all set to defaults anyway, so no issues or regressions
expected on older versions. (I doubt we were even using those features).

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/Doxyfile.in | 29 -----------------------------
>  1 file changed, 29 deletions(-)
> 
> diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> index e3b77428cd4f..dc03cbea4b02 100644
> --- a/Documentation/Doxyfile.in
> +++ b/Documentation/Doxyfile.in
> @@ -1769,16 +1769,6 @@ LATEX_BATCHMODE        = NO
>  
>  LATEX_HIDE_INDICES     = NO
>  
> -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
> -# code with syntax highlighting in the LaTeX output.
> -#
> -# Note that which sources are shown also depends on other settings such as
> -# SOURCE_BROWSER.
> -# The default value is: NO.
> -# This tag requires that the tag GENERATE_LATEX is set to YES.
> -
> -LATEX_SOURCE_CODE      = NO
> -
>  # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
>  # bibliography, e.g. plainnat, or ieeetr. See
>  # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
> @@ -1851,16 +1841,6 @@ RTF_STYLESHEET_FILE    =
>  
>  RTF_EXTENSIONS_FILE    =
>  
> -# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
> -# with syntax highlighting in the RTF output.
> -#
> -# Note that which sources are shown also depends on other settings such as
> -# SOURCE_BROWSER.
> -# The default value is: NO.
> -# This tag requires that the tag GENERATE_RTF is set to YES.
> -
> -RTF_SOURCE_CODE        = NO
> -
>  #---------------------------------------------------------------------------
>  # Configuration options related to the man page output
>  #---------------------------------------------------------------------------
> @@ -1950,15 +1930,6 @@ GENERATE_DOCBOOK       = NO
>  
>  DOCBOOK_OUTPUT         = docbook
>  
> -# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
> -# program listings (including syntax highlighting and cross-referencing
> -# information) to the DOCBOOK output. Note that enabling this will significantly
> -# increase the size of the DOCBOOK output.
> -# The default value is: NO.
> -# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
> -
> -DOCBOOK_PROGRAMLISTING = NO
> -
>  #---------------------------------------------------------------------------
>  # Configuration options for the AutoGen Definitions output
>  #---------------------------------------------------------------------------
>

Patch
diff mbox series

diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
index e3b77428cd4f..dc03cbea4b02 100644
--- a/Documentation/Doxyfile.in
+++ b/Documentation/Doxyfile.in
@@ -1769,16 +1769,6 @@  LATEX_BATCHMODE        = NO
 
 LATEX_HIDE_INDICES     = NO
 
-# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
-# code with syntax highlighting in the LaTeX output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_SOURCE_CODE      = NO
-
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
 # bibliography, e.g. plainnat, or ieeetr. See
 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
@@ -1851,16 +1841,6 @@  RTF_STYLESHEET_FILE    =
 
 RTF_EXTENSIONS_FILE    =
 
-# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
-# with syntax highlighting in the RTF output.
-#
-# Note that which sources are shown also depends on other settings such as
-# SOURCE_BROWSER.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_SOURCE_CODE        = NO
-
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
 #---------------------------------------------------------------------------
@@ -1950,15 +1930,6 @@  GENERATE_DOCBOOK       = NO
 
 DOCBOOK_OUTPUT         = docbook
 
-# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
-# program listings (including syntax highlighting and cross-referencing
-# information) to the DOCBOOK output. Note that enabling this will significantly
-# increase the size of the DOCBOOK output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_PROGRAMLISTING = NO
-
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------