vlp: Move closer to the code tested.
[kai/samba.git] / source3 / Doxyfile
1 # Doxyfile 1.5.3
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = Samba
7 PROJECT_NUMBER         = HEAD
8
9 # NOTE: By default, Doxygen writes into the dox/ subdirectory of the
10 # invocation directory.  If you want to put it somewhere else, for
11 # example, to write straight into a webserver directory, then override
12 # this variable in a configuration concatenated to this one: Doxygen
13 # doesn't mind variables being redefined.
14
15 OUTPUT_DIRECTORY       = dox
16 OUTPUT_LANGUAGE        = English
17 DOXYFILE_ENCODING      = UTF-8
18 BRIEF_MEMBER_DESC      = YES
19 REPEAT_BRIEF           = YES
20 ALWAYS_DETAILED_SEC    = NO
21 FULL_PATH_NAMES        = YES
22 STRIP_FROM_PATH        = $(PWD)/
23 SHORT_NAMES            = NO
24 JAVADOC_AUTOBRIEF      = YES
25 INHERIT_DOCS           = YES
26 TAB_SIZE               = 8
27 ALIASES                =
28 OPTIMIZE_OUTPUT_FOR_C  = YES
29 DISTRIBUTE_GROUP_DOC   = NO
30 #---------------------------------------------------------------------------
31 # Build related configuration options
32 #---------------------------------------------------------------------------
33 EXTRACT_ALL            = YES
34 EXTRACT_PRIVATE        = YES
35 EXTRACT_STATIC         = YES
36 EXTRACT_LOCAL_CLASSES  = YES
37 HIDE_UNDOC_MEMBERS     = NO
38 HIDE_UNDOC_CLASSES     = NO
39 INTERNAL_DOCS          = YES
40 CASE_SENSE_NAMES       = YES
41 HIDE_SCOPE_NAMES       = YES
42 SHOW_INCLUDE_FILES     = YES
43 INLINE_INFO            = YES
44 SORT_MEMBER_DOCS       = NO
45 SORT_BRIEF_DOCS        = NO
46 GENERATE_TODOLIST      = YES
47 GENERATE_TESTLIST      = YES
48 GENERATE_BUGLIST       = YES
49 GENERATE_DEPRECATEDLIST= YES
50 ENABLED_SECTIONS       = 
51 MAX_INITIALIZER_LINES  = 30
52 SHOW_USED_FILES        = YES
53 SHOW_DIRECTORIES       = YES
54 #---------------------------------------------------------------------------
55 # configuration options related to warning and progress messages
56 #---------------------------------------------------------------------------
57 QUIET                  = YES
58 WARNINGS               = NO
59 WARN_IF_UNDOCUMENTED   = NO
60 WARN_IF_DOC_ERROR      = NO
61 WARN_NO_PARAMDOC       = NO
62 WARN_FORMAT            = "$file:$line: $text"
63 WARN_LOGFILE           = 
64 #---------------------------------------------------------------------------
65 # configuration options related to the input files
66 #---------------------------------------------------------------------------
67 INPUT                  = . 
68 INPUT_ENCODING         = UTF-8
69 FILE_PATTERNS          = *.c \
70                          *.h \
71                          *.idl
72 RECURSIVE              = YES
73 EXCLUDE                = include/includes.h \
74                          include/proto.h
75 EXCLUDE_SYMLINKS       = NO
76 EXCLUDE_PATTERNS       = 
77 EXAMPLE_PATH           = 
78 EXAMPLE_PATTERNS       = 
79 EXAMPLE_RECURSIVE      = NO
80 IMAGE_PATH             = 
81 INPUT_FILTER           = 
82 FILTER_SOURCE_FILES    = NO
83 #---------------------------------------------------------------------------
84 # configuration options related to source browsing
85 #---------------------------------------------------------------------------
86 SOURCE_BROWSER         = YES
87 INLINE_SOURCES         = YES
88 STRIP_CODE_COMMENTS    = NO
89 REFERENCED_BY_RELATION = YES
90 REFERENCES_RELATION    = YES
91 REFERENCES_LINK_SOURCE = YES
92 VERBATIM_HEADERS       = YES
93 #---------------------------------------------------------------------------
94 # configuration options related to the alphabetical class index
95 #---------------------------------------------------------------------------
96 ALPHABETICAL_INDEX     = YES
97 COLS_IN_ALPHA_INDEX    = 1
98 IGNORE_PREFIX          = 
99 #---------------------------------------------------------------------------
100 # configuration options related to the HTML output
101 #---------------------------------------------------------------------------
102 GENERATE_HTML          = YES
103 HTML_OUTPUT            = .
104 HTML_FILE_EXTENSION    = .html
105 HTML_HEADER            = 
106 HTML_FOOTER            = 
107 HTML_STYLESHEET        = 
108 HTML_ALIGN_MEMBERS     = YES
109 GENERATE_HTMLHELP      = NO
110 TOC_EXPAND             = NO
111 DISABLE_INDEX          = NO
112 ENUM_VALUES_PER_LINE   = 3
113 GENERATE_TREEVIEW      = NO
114 TREEVIEW_WIDTH         = 250
115 #---------------------------------------------------------------------------
116 # configuration options related to the LaTeX output
117 #---------------------------------------------------------------------------
118 GENERATE_LATEX         = NO
119 LATEX_OUTPUT           = latex
120 COMPACT_LATEX          = NO
121 PAPER_TYPE             = a4wide
122 EXTRA_PACKAGES         = 
123 LATEX_HEADER           = 
124 PDF_HYPERLINKS         = YES
125 USE_PDFLATEX           = YES
126 LATEX_BATCHMODE        = YES
127 #---------------------------------------------------------------------------
128 # configuration options related to the RTF output
129 #---------------------------------------------------------------------------
130 GENERATE_RTF           = NO
131 RTF_OUTPUT             = rtf
132 COMPACT_RTF            = NO
133 RTF_HYPERLINKS         = NO
134 RTF_STYLESHEET_FILE    = 
135 RTF_EXTENSIONS_FILE    = 
136 #---------------------------------------------------------------------------
137 # configuration options related to the man page output
138 #---------------------------------------------------------------------------
139 GENERATE_MAN           = NO
140 MAN_OUTPUT             = man
141 MAN_EXTENSION          = .3
142 MAN_LINKS              = NO
143 #---------------------------------------------------------------------------
144 # configuration options related to the XML output
145 #---------------------------------------------------------------------------
146 GENERATE_XML           = NO
147 #---------------------------------------------------------------------------
148 # configuration options related to the preprocessor   
149 #---------------------------------------------------------------------------
150 ENABLE_PREPROCESSING   = NO
151 MACRO_EXPANSION        = NO
152 EXPAND_ONLY_PREDEF     = NO
153 SEARCH_INCLUDES        = YES
154 INCLUDE_PATH           = 
155 INCLUDE_FILE_PATTERNS  = 
156 PREDEFINED             = 
157 EXPAND_AS_DEFINED      = 
158 SKIP_FUNCTION_MACROS   = YES
159 #---------------------------------------------------------------------------
160 # configuration::additions related to external references   
161 #---------------------------------------------------------------------------
162 TAGFILES               = 
163 GENERATE_TAGFILE       = 
164 ALLEXTERNALS           = NO
165 PERL_PATH              = /usr/bin/perl
166 #---------------------------------------------------------------------------
167 # configuration options related to the dot tool   
168 #---------------------------------------------------------------------------
169 HAVE_DOT               = NO
170 CLASS_DIAGRAMS         = YES
171 HIDE_UNDOC_RELATIONS   = NO
172 CLASS_GRAPH            = YES
173 COLLABORATION_GRAPH    = YES
174 GROUP_GRAPHS           = YES
175 TEMPLATE_RELATIONS     = YES
176 INCLUDE_GRAPH          = YES
177 INCLUDED_BY_GRAPH      = YES
178 CALL_GRAPH             = YES
179 CALLER_GRAPH           = YES
180 GRAPHICAL_HIERARCHY    = YES
181 DIRECTORY_GRAPH        = YES
182 DOT_IMAGE_FORMAT       = png
183 DOT_PATH               = 
184 DOTFILE_DIRS           = 
185 DOT_GRAPH_MAX_NODES    = 50
186 MAX_DOT_GRAPH_DEPTH    = 0
187 GENERATE_LEGEND        = YES
188 DOT_CLEANUP            = YES
189 #---------------------------------------------------------------------------
190 # configuration::additions related to the search engine   
191 #---------------------------------------------------------------------------
192 SEARCHENGINE           = NO