summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBerke Viktor <bviktor@hexchat.org>2013-05-20 12:31:09 +0200
committerBerke Viktor <bviktor@hexchat.org>2013-05-20 12:31:09 +0200
commit341cfbb527e7a566d146b1b4dcdae286f9b530ef (patch)
treed363c7293ef803540419c20caff609f2cb33421b
parent78573ae0c9f903968e1ebaabb0c5894f93b05566 (diff)
Set up Doxyfile
-rw-r--r--.gitignore2
-rw-r--r--Doxyfile56
2 files changed, 30 insertions, 28 deletions
diff --git a/.gitignore b/.gitignore
index f32a5177..d9378370 100644
--- a/.gitignore
+++ b/.gitignore
@@ -20,6 +20,8 @@ config.sub
 configure
 configure.tmp
 depcomp
+doxygen*.tmp
+html/
 install-sh
 intl/
 libtool
diff --git a/Doxyfile b/Doxyfile
index 4f2dc444..4c1d2591 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -28,7 +28,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           = "My Project"

+PROJECT_NAME           = "HexChat"

 

 # The PROJECT_NUMBER tag can be used to enter a project or revision number.

 # This could be handy for archiving the generated documentation or

@@ -40,14 +40,14 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer

 # a quick idea about the purpose of the project. Keep the description short.

 

-PROJECT_BRIEF          =

+PROJECT_BRIEF          = "HexChat IRC Client"

 

 # With the PROJECT_LOGO tag one can specify an logo or icon that is

 # included in the documentation. The maximum height of the logo should not

 # exceed 55 pixels and the maximum width should not exceed 200 pixels.

 # Doxygen will copy the logo to the output directory.

 

-PROJECT_LOGO           =

+PROJECT_LOGO           = "share/icons/hexchat.svg"

 

 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)

 # base path where the generated documentation will be put.

@@ -351,7 +351,7 @@ LOOKUP_CACHE_SIZE      = 0
 # Private class members and static file members will be hidden unless

 # the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES

 

-EXTRACT_ALL            = NO

+EXTRACT_ALL            = YES

 

 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class

 # will be included in the documentation.

@@ -366,7 +366,7 @@ EXTRACT_PACKAGE        = NO
 # If the EXTRACT_STATIC tag is set to YES all static members of a file

 # will be included in the documentation.

 

-EXTRACT_STATIC         = NO

+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.

@@ -443,7 +443,7 @@ HIDE_SCOPE_NAMES       = NO
 # will put a list of the files that are included by a file in the documentation

 # of that file.

 

-SHOW_INCLUDE_FILES     = YES

+SHOW_INCLUDE_FILES     = NO

 

 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen

 # will list include files with double quotes in the documentation

@@ -468,7 +468,7 @@ SORT_MEMBER_DOCS       = YES
 # by member name. If set to NO (the default) the members will appear in

 # declaration order.

 

-SORT_BRIEF_DOCS        = NO

+SORT_BRIEF_DOCS        = YES

 

 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen

 # will sort the (brief and detailed) documentation of class members so that

@@ -654,7 +654,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories

 # with spaces.

 

-INPUT                  =

+INPUT                  = "src/common" "src/fe-gtk"

 

 # 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

@@ -672,7 +672,7 @@ INPUT_ENCODING         = UTF-8
 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py

 # *.f90 *.f *.for *.vhd *.vhdl

 

-FILE_PATTERNS          =

+FILE_PATTERNS          = *.c

 

 # 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.

@@ -790,7 +790,7 @@ USE_MDFILE_AS_MAINPAGE =
 # Note: To get rid of all source code in the generated output, make sure also

 # VERBATIM_HEADERS is set to NO.

 

-SOURCE_BROWSER         = NO

+SOURCE_BROWSER         = YES

 

 # Setting the INLINE_SOURCES tag to YES will include the body

 # of functions and classes directly in the documentation.

@@ -801,7 +801,7 @@ INLINE_SOURCES         = NO
 # doxygen to hide any special comment blocks from generated source code

 # fragments. Normal C, C++ and Fortran comments will always remain visible.

 

-STRIP_CODE_COMMENTS    = YES

+STRIP_CODE_COMMENTS    = NO

 

 # If the REFERENCED_BY_RELATION tag is set to YES

 # then for each documented function all documented

@@ -1300,7 +1300,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will

 # generate Latex output.

 

-GENERATE_LATEX         = YES

+GENERATE_LATEX         = NO

 

 # 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

@@ -1711,7 +1711,7 @@ HIDE_UNDOC_RELATIONS   = YES
 # toolkit from AT&T and Lucent Bell Labs. The other options in this section

 # have no effect if this option is set to NO (the default)

 

-HAVE_DOT               = NO

+HAVE_DOT               = YES

 

 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is

 # allowed to run in parallel. When set to 0 (the default) doxygen will

@@ -1746,19 +1746,19 @@ DOT_FONTPATH           =
 # indirect inheritance relations. Setting this tag to YES will force the

 # CLASS_DIAGRAMS tag to NO.

 

-CLASS_GRAPH            = YES

+CLASS_GRAPH            = NO

 

 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen

 # will generate a graph for each documented class showing the direct and

 # indirect implementation dependencies (inheritance, containment, and

 # class references variables) of the class with other documented classes.

 

-COLLABORATION_GRAPH    = YES

+COLLABORATION_GRAPH    = NO

 

 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen

 # will generate a graph for groups, showing the direct groups dependencies

 

-GROUP_GRAPHS           = YES

+GROUP_GRAPHS           = NO

 

 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and

 # collaboration diagrams in a style similar to the OMG's Unified Modeling

@@ -1785,14 +1785,14 @@ TEMPLATE_RELATIONS     = NO
 # file showing the direct and indirect include dependencies of the file with

 # other documented files.

 

-INCLUDE_GRAPH          = YES

+INCLUDE_GRAPH          = NO

 

 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and

 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each

 # documented header file showing the documented files that directly or

 # indirectly include this file.

 

-INCLUDED_BY_GRAPH      = YES

+INCLUDED_BY_GRAPH      = NO

 

 # If the CALL_GRAPH and HAVE_DOT options are set to YES then

 # doxygen will generate a call dependency graph for every global function

@@ -1800,7 +1800,7 @@ INCLUDED_BY_GRAPH      = YES
 # the time of a run. So in most cases it will be better to enable call graphs

 # for selected functions only using the \callgraph command.

 

-CALL_GRAPH             = NO

+CALL_GRAPH             = YES

 

 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then

 # doxygen will generate a caller dependency graph for every global function

@@ -1808,19 +1808,19 @@ CALL_GRAPH             = NO
 # the time of a run. So in most cases it will be better to enable caller

 # graphs for selected functions only using the \callergraph command.

 

-CALLER_GRAPH           = NO

+CALLER_GRAPH           = YES

 

 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen

 # will generate a graphical hierarchy of all classes instead of a textual one.

 

-GRAPHICAL_HIERARCHY    = YES

+GRAPHICAL_HIERARCHY    = NO

 

 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES

 # then doxygen will show the dependencies a directory has on other directories

 # in a graphical way. The dependency relations are determined by the #include

 # relations between the files in the directories.

 

-DIRECTORY_GRAPH        = YES

+DIRECTORY_GRAPH        = NO

 

 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images

 # generated by dot. Possible values are svg, png, jpg, or gif.

@@ -1828,7 +1828,7 @@ DIRECTORY_GRAPH        = YES
 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files

 # visible in IE 9+ (other browsers do not have this requirement).

 

-DOT_IMAGE_FORMAT       = png

+DOT_IMAGE_FORMAT       = svg

 

 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to

 # enable generation of interactive SVG images that allow zooming and panning.

@@ -1837,7 +1837,7 @@ DOT_IMAGE_FORMAT       = png
 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files

 # visible. Older versions of IE do not have SVG support.

 

-INTERACTIVE_SVG        = NO

+INTERACTIVE_SVG        = YES

 

 # The tag DOT_PATH can be used to specify the path where the dot tool can be

 # found. If left blank, it is assumed the dot tool can be found in the path.

@@ -1864,7 +1864,7 @@ MSCFILE_DIRS           =
 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note

 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.

 

-DOT_GRAPH_MAX_NODES    = 50

+DOT_GRAPH_MAX_NODES    = 1000

 

 # 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

@@ -1874,7 +1874,7 @@ DOT_GRAPH_MAX_NODES    = 50
 # code bases. Also note that the size of a graph can be further restricted by

 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.

 

-MAX_DOT_GRAPH_DEPTH    = 0

+MAX_DOT_GRAPH_DEPTH    = 2

 

 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent

 # background. This is disabled by default, because dot on Windows does not

@@ -1882,14 +1882,14 @@ MAX_DOT_GRAPH_DEPTH    = 0
 # enabling this option may lead to badly anti-aliased labels on the edges of

 # a graph (i.e. they become hard to read).

 

-DOT_TRANSPARENT        = NO

+DOT_TRANSPARENT        = YES

 

 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output

 # files in one run (i.e. multiple -o and -T options on the command line). This

 # 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      = NO

+DOT_MULTI_TARGETS      = YES

 

 # 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