X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fsrc%2FDoxyfile;h=6d9ccb5b7f6a1b974af4c813559ba57d84b6f16e;hb=571b1a8b83bee56a75728d44d2586a816401d434;hp=1434103ffbb0b5e88cfceed37fa37fae21c36929;hpb=7036111a6c567d7283c43de12f32ce1083413315;p=ngircd-alex.git diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile index 1434103f..6d9ccb5b 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,117 +8,74 @@ # (at your option) any later version. # Please read the file COPYING, README and AUTHORS for more information. # -# $Id: Doxyfile,v 1.1 2005/07/22 20:58:22 alex Exp $ -# - # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for ngIRCd. +# #--------------------------------------------------------------------------- # 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 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. +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 -# 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_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. +SHOW_DIRECTORIES = YES + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- -EXTRACT_LOCAL_CLASSES = YES +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = YES #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# 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. - 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. - +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 +STRIP_CODE_COMMENTS = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES #--------------------------------------------------------------------------- # Output formats #--------------------------------------------------------------------------- GENERATE_HTML = YES - -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = header.inc.html HTML_FOOTER = footer.inc.html -HTML_STYLESHEET = ngircd-doc.css +HTML_DYNAMIC_SECTIONS = YES +GENERATE_DOCSET = NO GENERATE_HTMLHELP = NO GENERATE_LATEX = NO GENERATE_RTF = NO @@ -131,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 = CONN_MODULE __client_c__ +PREDEFINED = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__ # -eof-