[haiku-doc] Simple patch Doxyfile

Hi Guys,

I've been looking at reducing the warnings generated by Doxygen when it is
run against the docs directory. It would be good to get rid of them.

I've made a start with the Doxyfile. I observed the following warnings:

Warning: Tag `USE_WINDOWS_ENCODING' at line 64 of file Doxyfile has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `MAX_DOT_GRAPH_WIDTH' at line 1215 of file Doxyfile has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `MAX_DOT_GRAPH_HEIGHT' at line 1223 of file Doxyfile has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `MAX_DOT_GRAPH_DEPTH' at line 1235 of file Doxyfile has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"

I have run the "doxygen -u" command as suggested. The attached diff file is
the result. It seems to have cured the problem. There are plenty more
warnings to fix though :-)

Does this patch look ok as I am in the hands of the Doxygen gods with this
one!

Will be offline for a few days (on a work course) so I'll deal with any
comments you may have this weekend when I'm back.

Cheers

Alan

Index: Doxyfile
===================================================================
--- Doxyfile    (revision 21208)
+++ Doxyfile    (working copy)
@@ -1,4 +1,4 @@
-# Doxyfile 1.5.1-p1
+# Doxyfile 1.5.2
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project
@@ -14,6 +14,14 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 
+# This tag specifies the encoding used for all characters in the config file 
that 
+# follow. The default is UTF-8 which is also the encoding used for all text 
before 
+# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built 
into 
+# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the 
list of 
+# possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
 
@@ -53,16 +61,6 @@
 
 OUTPUT_LANGUAGE        = English
 
-# This tag can be used to specify the encoding used in the generated output. 
-# The encoding is not always determined by the language that is chosen, 
-# but also whether or not the output is meant for Windows or non-Windows 
users. 
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
-# forces the Windows encoding (this is the default for the Windows binary), 
-# whereas setting the tag to NO uses a Unix-style encoding (the default for 
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING   = YES
-
 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
 # include brief member descriptions after the members that are listed in 
 # the file and class documentation (similar to JavaDoc). 
@@ -204,6 +202,11 @@
 
 BUILTIN_STL_SUPPORT    = NO
 
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
 # tag is set to YES, then doxygen will reuse the documentation of the first 
 # member in the group (if any) for the other members of the group. By default 
@@ -471,6 +474,13 @@
                          ../../headers/os/support \
                          ../../headers/posix/syslog.h
 
+# This tag can be used to specify the character encoding of the source files 
that 
+# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also 
the default 
+# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the 
transcoding. 
+# See http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
+
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 # and *.h) to filter out the source-files in the directories. If left 
@@ -509,6 +519,13 @@
 
 EXCLUDE_PATTERNS       = */libkernelppp/_KPPP*
 
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
+# (namespaces, classes, functions, etc.) that should be excluded from the 
output. 
+# The symbol name can be a fully qualified name, a word, or if the wildcard * 
is used, 
+# a substring. Examples: ANamespace, AClass, AClass::ANamespace, 
ANamespace::*Test
+
+EXCLUDE_SYMBOLS        = 
+
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
 # the \include command).
@@ -1026,13 +1043,9 @@
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
 
-# Beep.h and SupportDefs.h require __cplusplus to be defined.
-# SupportDefs.h defines some things that are also defined in types.h. There's
-#   check whether or not types.h has already been included. There is no need
-#   to put these definitions in our docs.
+PREDEFINED             = __cplusplus \
+                         _SYS_TYPES_H
 
-PREDEFINED             = __cplusplus _SYS_TYPES_H
-
 # 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. 
 # The macro definition that is found in the sources will be used. 
@@ -1104,6 +1117,14 @@
 
 CLASS_DIAGRAMS         = YES
 
+# You can define message sequence charts within doxygen comments using the 
\msc 
+# command. Doxygen will then run the mscgen tool (see 
http://www.mcternan.me.uk/mscgen/) to 
+# produce the chart and insert it in the documentation. The MSCGEN_PATH tag 
allows you to 
+# specify the directory where the mscgen tool resides. If left empty the tool 
is assumed to 
+# be found in the default search path.
+
+MSCGEN_PATH            = 
+
 # If set to YES, the inheritance and collaboration graphs will hide 
 # inheritance and usage relations if the target is undocumented 
 # or is not a class.
@@ -1206,34 +1227,14 @@
 
 DOTFILE_DIRS           = 
 
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
+# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
+# nodes that will be shown in the graph. If the number of nodes in a graph 
+# becomes larger than this value, doxygen will truncate the graph, which is 
+# visualized by representing a node as a red box. Note that doxygen will 
always 
+# show the root nodes and its direct children regardless of this setting.
 
-MAX_DOT_GRAPH_WIDTH    = 1024
+DOT_GRAPH_MAX_NODES    = 50
 
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_HEIGHT   = 1024
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
-# graphs generated by dot. A depth value of 3 means that only nodes reachable 
-# from the root by following a path via at most 3 edges will be shown. Nodes 
-# that lay further from the root node will be omitted. Note that setting this 
-# option to 1 or 2 may greatly reduce the computation time needed for large 
-# code bases. Also note that a graph may be further truncated if the graph's 
-# image dimensions are not sufficient to fit the graph (see 
MAX_DOT_GRAPH_WIDTH 
-# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
-# the graph is not depth-constrained.
-
-MAX_DOT_GRAPH_DEPTH    = 0
-
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
 # background. This is disabled by default, which results in a white 
background. 
 # Warning: Depending on the platform used, enabling this option may lead to

Other related posts: