From 408cefd15d4540d340283cdfbfad62a8e432cf8e Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Sun, 26 Dec 2010 19:32:07 +0100 Subject: [PATCH] Updated Doxygen configuration file Removed unnecessary variables DETAILS_AT_TOP, EXTRACT_PRIVATE, EXTRACT_LOCAL_CLASSES, added SHOW_DIRECTORIES=YES, STRIP_CODE_COMMENTS=NO, REFERENCED_BY_RELATION=YES, REFERENCES_RELATION=YES, HTML_DYNAMIC_SECTIONS=YES and GENERATE_DOCSET=NO; updated PREDEFINED. --- doc/src/Doxyfile | 53 +++++++++++++++++++++++++++++------------------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile index 55363e11..62a219ca 100644 --- a/doc/src/Doxyfile +++ b/doc/src/Doxyfile @@ -1,6 +1,6 @@ # # ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2005 Alexander Barton (alex@barton.de) +# Copyright (c)2001-2010 Alexander Barton (alex@barton.de) # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -8,11 +8,9 @@ # (at your option) any later version. # Please read the file COPYING, README and AUTHORS for more information. # -# $Id: Doxyfile,v 1.2 2005/07/23 00:48:38 alex Exp $ -# - # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for ngIRCd. +# #--------------------------------------------------------------------------- # Project related configuration options @@ -47,13 +45,6 @@ STRIP_FROM_PATH = ../.. JAVADOC_AUTOBRIEF = YES -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - # 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 @@ -72,21 +63,16 @@ OPTIMIZE_OUTPUT_FOR_C = YES EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = 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 EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# 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. -EXTRACT_LOCAL_CLASSES = YES +SHOW_DIRECTORIES = YES #--------------------------------------------------------------------------- # configuration options related to the input files @@ -116,6 +102,22 @@ RECURSIVE = YES 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 + #--------------------------------------------------------------------------- # Output formats #--------------------------------------------------------------------------- @@ -128,6 +130,15 @@ GENERATE_HTML = YES 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 GENERATE_HTMLHELP = NO GENERATE_LATEX = NO GENERATE_RTF = NO @@ -148,6 +159,6 @@ GENERATE_PERLMOD = NO # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = CONN_MODULE __client_c__ +PREDEFINED = DEBUG CONN_MODULE __client_c__ # -eof-