Update Doxygen configuration
authorAlexander Barton <alex@barton.de>
Fri, 22 Feb 2013 17:11:26 +0000 (18:11 +0100)
committerAlexander Barton <alex@barton.de>
Fri, 22 Feb 2013 17:11:26 +0000 (18:11 +0100)
doc/src/Doxyfile
doc/src/footer.inc.html

index 8afec5e..6d9ccb5 100644 (file)
 # Project related configuration options
 #---------------------------------------------------------------------------
 
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
-# by quotes) that should identify the project.
+DOXYFILE_ENCODING      = UTF-8
 
 PROJECT_NAME           = ngIRCd
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
-# base path where the generated documentation will be put. 
-# If a relative path is entered, it will be relative to the location 
-# where doxygen was started. If left blank the current directory will be used.
+PROJECT_BRIEF          = "Lightweight Internet Relay Chat server"
+PROJECT_LOGO           = "../../contrib/ngIRCd-Logo.gif"
 
 OUTPUT_DIRECTORY       = .
-
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
-# can be used to strip a user-defined part of the path. Stripping is 
-# only done if one of the specified strings matches the left-hand part of 
-# the path. The tag can be used to show relative paths in the file list. 
-# If left blank the directory from which doxygen is run is used as the 
-# path to strip.
-
 STRIP_FROM_PATH        = ../..
 
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
-# will interpret the first line (until the first dot) of a JavaDoc-style 
-# comment as the brief description. If set to NO, the JavaDoc 
-# comments will behave just like the Qt-style comments (thus requiring an 
-# explicit @brief command for a brief description.
-
 JAVADOC_AUTOBRIEF      = YES
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
-# sources only. Doxygen will then generate output that is more tailored for C. 
-# For instance, some of the names that are used will be different. The list 
-# of all members will be omitted, etc.
-
 OPTIMIZE_OUTPUT_FOR_C  = YES
+TYPEDEF_HIDES_STRUCT   = YES
+
+TAB_SIZE               = 8
 
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
 
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
-# documentation are documented, even if no documentation was available. 
-# Private class members and static file members will be hidden unless 
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-
 EXTRACT_ALL            = YES
-
-# If the EXTRACT_STATIC tag is set to YES all static members of a file 
-# will be included in the documentation.
-
 EXTRACT_STATIC         = YES
 
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory
-# hierarchy in the documentation. The default is NO.
-
 SHOW_DIRECTORIES       = YES
 
 #---------------------------------------------------------------------------
-# configuration options related to the input files
+# configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
 
-# The INPUT tag can be used to specify the files and/or directories that
-# contain documented source files. You may enter file names like "myfile.cpp"
-# or directories like "/usr/src/myproject". Separate the files or directories 
-# with spaces.
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = YES
 
-INPUT                  = ../../src
-
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
-# should be searched for input files as well. Possible values are YES and NO. 
-# If left blank NO is used.
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
 
+INPUT                  = ../../src
+INPUT_ENCODING         = UTF-8
 RECURSIVE              = YES
 
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
 
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
-# be generated. Documented entities will be cross-referenced with these sources. 
-# Note: To get rid of all source code in the generated output, make sure also 
-# VERBATIM_HEADERS is set to NO.
-
 SOURCE_BROWSER         = YES
-
-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
-# doxygen to hide any special comment blocks from generated source code
-# fragments. Normal C and C++ comments will always remain visible.
-
 STRIP_CODE_COMMENTS    = NO
-
-# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
-# function all documented functions referencing it will be listed.
-
 REFERENCED_BY_RELATION = YES
-
-# If the REFERENCES_RELATION tag is set to YES then for each documented
-# function all documented entities called/used by that function will be listed.
-
 REFERENCES_RELATION    = YES
 
 #---------------------------------------------------------------------------
@@ -123,19 +72,7 @@ REFERENCES_RELATION    = YES
 #---------------------------------------------------------------------------
 
 GENERATE_HTML          = YES
-
-# The HTML_FOOTER tag can be used to specify a personal HTML footer for each
-# generated HTML page. If it is left blank doxygen will generate a standard
-# footer.
-
 HTML_FOOTER            = footer.inc.html
-
-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
-# documentation will contain sections that can be hidden and shown after the
-# page has loaded. For this to work a browser that supports JavaScript and
-# DHTML is required (for instance Mozilla 1.0+, Firefox Netscape 6.0+,
-# Internet explorer 5.0+, Konqueror, or Safari).
-
 HTML_DYNAMIC_SECTIONS  = YES
 
 GENERATE_DOCSET        = NO
@@ -151,14 +88,6 @@ GENERATE_PERLMOD       = NO
 # Configuration options related to the preprocessor   
 #---------------------------------------------------------------------------
 
-# The PREDEFINED tag can be used to specify one or more macro names that 
-# are defined before the preprocessor is started (similar to the -D option of 
-# gcc). The argument of the tag is a list of macros of the form: name 
-# or name=definition (no spaces). If the definition and the = are 
-# omitted =1 is assumed. To prevent a macro definition from being 
-# undefined via #undef or recursively expanded use the := operator 
-# instead of the = operator.
-
 PREDEFINED             = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__
 
 # -eof-
index a3a9552..ba05dcf 100644 (file)
@@ -1,6 +1,6 @@
 
 <hr class="footer">
-<p>
+<p style="text-align: center">
   ngIRCd
   <a href="http://ngircd.barton.de/">Homepage</a>,
   <a href="http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git">GIT-Repository</a>,