Re: [PATCH wayland 1/2] doc: move project-specific doxygen settings to the end of the doxygen file

2015-06-16 Thread Pekka Paalanen
On Fri,  5 Jun 2015 15:30:22 +1000
Peter Hutterer  wrote:

> Rather than having the settings hidden in the file somewhere move them to the
> end so it's clear which settings we intentionally override.
> 
> Signed-off-by: Peter Hutterer 
> ---
>  doc/doxygen/wayland.doxygen.in | 41 +++--
>  1 file changed, 31 insertions(+), 10 deletions(-)
> 
> diff --git a/doc/doxygen/wayland.doxygen.in b/doc/doxygen/wayland.doxygen.in
> index e64512f..38c38f8 100644
> --- a/doc/doxygen/wayland.doxygen.in
> +++ b/doc/doxygen/wayland.doxygen.in

> @@ -1734,3 +1739,19 @@ GENERATE_LEGEND= YES
>  # the various graphs.
>  
>  DOT_CLEANUP= YES
> +
> +
> +# Wayland-specific overrides
> +PROJECT_NAME   = "Wayland"
> +PROJECT_NUMBER = @VERSION@
> +OUTPUT_DIRECTORY   = @top_builddir@/doc/doxygen
> +JAVADOC_AUTOBRIEF  = YES
> +TAB_SIZE   = 8
> +QUIET  = YES
> +HTML_TIMESTAMP = YES
> +GENERATE_LATEX = NO
> +MAN_LINKS  = YES
> +PREDEFINED = WL_EXPORT=
> +MACRO_EXPANSION= YES
> +EXPAND_ONLY_PREDEF = YES
> +DOT_MULTI_TARGETS  = YES

Hi,

I did a check against the defaults of Doxygen 1.8.9.1.

Missing:

ALIASES+= comment{1}="/* \1 */"
GENERATE_HTML defaults to YES, while we had NO.

doc/doxygen/Makefile.am has some ad hoc overrides as well.

I like the idea.


Thanks,
pq
___
wayland-devel mailing list
wayland-devel@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/wayland-devel


[PATCH wayland 1/2] doc: move project-specific doxygen settings to the end of the doxygen file

2015-06-04 Thread Peter Hutterer
Rather than having the settings hidden in the file somewhere move them to the
end so it's clear which settings we intentionally override.

Signed-off-by: Peter Hutterer 
---
 doc/doxygen/wayland.doxygen.in | 41 +++--
 1 file changed, 31 insertions(+), 10 deletions(-)

diff --git a/doc/doxygen/wayland.doxygen.in b/doc/doxygen/wayland.doxygen.in
index e64512f..38c38f8 100644
--- a/doc/doxygen/wayland.doxygen.in
+++ b/doc/doxygen/wayland.doxygen.in
@@ -1,5 +1,10 @@
 # Doxyfile 1.7.6.1
 
+#
+# WARNING: do not edit options in-place. Append them to the end of this
+# file instead.
+#
+
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
 #
@@ -26,7 +31,7 @@ DOXYFILE_ENCODING  = UTF-8
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME   = "Wayland"
+PROJECT_NAME   = "My Project"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
@@ -151,7 +156,7 @@ SHORT_NAMES= NO
 # comments will behave just like regular Qt-style comments
 # (thus requiring an explicit @brief command for a brief description.)
 
-JAVADOC_AUTOBRIEF  = YES
+JAVADOC_AUTOBRIEF  = NO
 
 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
 # interpret the first line (until the first dot) of a Qt-style
@@ -184,7 +189,7 @@ SEPARATE_MEMBER_PAGES  = NO
 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
 # Doxygen uses this value to replace tabs by spaces in code fragments.
 
-TAB_SIZE   = 8
+TAB_SIZE   = 4
 
 # This tag can be used to specify a number of aliases that acts
 # as commands in the documentation. An alias has the form "name=value".
@@ -573,7 +578,7 @@ CITE_BIB_FILES =
 # The QUIET tag can be used to turn on/off the messages that are generated
 # by doxygen. Possible values are YES and NO. If left blank NO is used.
 
-QUIET  = YES
+QUIET  = NO
 
 # The WARNINGS tag can be used to turn on/off the warning messages that are
 # generated by doxygen. Possible values are YES and NO. If left blank
@@ -1177,7 +1182,7 @@ SERVER_BASED_SEARCH= NO
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 # generate Latex output.
 
-GENERATE_LATEX = NO
+GENERATE_LATEX = YES
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -1337,7 +1342,7 @@ MAN_EXTENSION  = .3
 # only source the real man page, but without them the man command
 # would be unable to find the correct page. The default is NO.
 
-MAN_LINKS  = YES
+MAN_LINKS  = NO
 
 #---
 # configuration options related to the XML output
@@ -1424,13 +1429,13 @@ ENABLE_PREPROCESSING   = YES
 # compilation will be performed. Macro expansion can be done in a controlled
 # way by setting EXPAND_ONLY_PREDEF to YES.
 
-MACRO_EXPANSION= YES
+MACRO_EXPANSION= NO
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 # then the macro expansion is limited to the macros specified with the
 # PREDEFINED and EXPAND_AS_DEFINED tags.
 
-EXPAND_ONLY_PREDEF = YES
+EXPAND_ONLY_PREDEF = NO
 
 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 # pointed to by INCLUDE_PATH will be searched when a #include is found.
@@ -1458,7 +1463,7 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 
-PREDEFINED = WL_EXPORT=
+PREDEFINED =
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be 
expanded.
@@ -1721,7 +1726,7 @@ DOT_TRANSPARENT= NO
 # makes dot run faster, but since only newer versions of dot (>1.8.10)
 # support this, this feature is disabled by default.
 
-DOT_MULTI_TARGETS  = YES
+DOT_MULTI_TARGETS  = NO
 
 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
 # generate a legend page explaining the meaning of the various boxes and
@@ -1734,3 +1739,19 @@ GENERATE_LEGEND= YES
 # the various graphs.
 
 DOT_CLEANUP= YES
+
+
+# Wayland-specific overrides
+PROJECT_NAME   = "Wayland"
+PROJECT_NUMBER = @VERSION@
+OUTPUT_DIRECTORY   = @top_builddir@/doc/doxygen
+JAVADOC_AUTOBRIEF  = YES
+TAB_SIZE   = 8
+QUIET  = YES
+HTML_TIMESTAMP = YES
+GENERATE_LATEX