This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[kai/samba.git] / source3 / Doxyfile
1 # Doxyfile 0.1
2
3 #---------------------------------------------------------------------------
4 # General 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
17 OUTPUT_LANGUAGE        = English
18 EXTRACT_ALL            = YES
19 EXTRACT_PRIVATE        = YES
20 EXTRACT_STATIC         = YES
21 HIDE_UNDOC_MEMBERS     = NO
22 HIDE_UNDOC_CLASSES     = NO
23 BRIEF_MEMBER_DESC      = YES
24 REPEAT_BRIEF           = YES
25 ALWAYS_DETAILED_SEC    = NO
26 FULL_PATH_NAMES        = YES
27 STRIP_FROM_PATH        = $(PWD)/
28 INTERNAL_DOCS          = YES
29 CLASS_DIAGRAMS         = YES
30 SOURCE_BROWSER         = YES
31 INLINE_SOURCES         = YES
32 STRIP_CODE_COMMENTS    = NO
33 CASE_SENSE_NAMES       = YES
34 SHORT_NAMES            = NO
35 HIDE_SCOPE_NAMES       = YES
36 VERBATIM_HEADERS       = YES
37 SHOW_INCLUDE_FILES     = YES
38 JAVADOC_AUTOBRIEF      = YES
39 INHERIT_DOCS           = YES
40 INLINE_INFO            = YES
41 SORT_MEMBER_DOCS       = NO
42 DISTRIBUTE_GROUP_DOC   = NO
43 TAB_SIZE               = 8
44 GENERATE_TODOLIST      = YES
45 GENERATE_TESTLIST      = YES
46 GENERATE_BUGLIST       = YES
47 ALIASES                = 
48 ENABLED_SECTIONS       = 
49 MAX_INITIALIZER_LINES  = 30
50 OPTIMIZE_OUTPUT_FOR_C  = YES
51 SHOW_USED_FILES        = YES
52 REFERENCED_BY_RELATION = YES
53 #---------------------------------------------------------------------------
54 # configuration options related to warning and progress messages
55 #---------------------------------------------------------------------------
56 QUIET                  = YES
57 WARNINGS               = NO
58 WARN_IF_UNDOCUMENTED   = NO
59 WARN_FORMAT            = "$file:$line: $text"
60 WARN_LOGFILE           = 
61 #---------------------------------------------------------------------------
62 # configuration options related to the input files
63 #---------------------------------------------------------------------------
64 INPUT                  = . 
65 FILE_PATTERNS          = *.c \
66                          *.h \
67                          *.idl
68 RECURSIVE              = YES
69 EXCLUDE                = include/includes.h \
70                          include/proto.h
71 EXCLUDE_PATTERNS       = 
72 EXAMPLE_PATH           = 
73 EXAMPLE_PATTERNS       = 
74 IMAGE_PATH             = 
75 INPUT_FILTER           = 
76 FILTER_SOURCE_FILES    = NO
77 #---------------------------------------------------------------------------
78 # configuration options related to the alphabetical class index
79 #---------------------------------------------------------------------------
80 ALPHABETICAL_INDEX     = YES
81 COLS_IN_ALPHA_INDEX    = 1
82 IGNORE_PREFIX          = 
83 #---------------------------------------------------------------------------
84 # configuration options related to the HTML output
85 #---------------------------------------------------------------------------
86 GENERATE_HTML          = YES
87 HTML_OUTPUT            = .
88 HTML_HEADER            = 
89 HTML_FOOTER            = 
90 HTML_STYLESHEET        = 
91 HTML_ALIGN_MEMBERS     = YES
92 GENERATE_HTMLHELP      = NO
93 GENERATE_CHI           = NO
94 BINARY_TOC             = NO
95 TOC_EXPAND             = NO
96 DISABLE_INDEX          = NO
97 ENUM_VALUES_PER_LINE   = 3
98 GENERATE_TREEVIEW      = NO
99 TREEVIEW_WIDTH         = 250
100 #---------------------------------------------------------------------------
101 # configuration options related to the LaTeX output
102 #---------------------------------------------------------------------------
103 GENERATE_LATEX         = NO
104 LATEX_OUTPUT           = latex
105 COMPACT_LATEX          = NO
106 PAPER_TYPE             = a4wide
107 EXTRA_PACKAGES         = 
108 LATEX_HEADER           = 
109 PDF_HYPERLINKS         = YES
110 USE_PDFLATEX           = YES
111 LATEX_BATCHMODE        = YES
112 #---------------------------------------------------------------------------
113 # configuration options related to the RTF output
114 #---------------------------------------------------------------------------
115 GENERATE_RTF           = NO
116 RTF_OUTPUT             = rtf
117 COMPACT_RTF            = NO
118 RTF_HYPERLINKS         = NO
119 RTF_STYLESHEET_FILE    = 
120 RTF_EXTENSIONS_FILE    = 
121 #---------------------------------------------------------------------------
122 # configuration options related to the man page output
123 #---------------------------------------------------------------------------
124 GENERATE_MAN           = NO
125 MAN_OUTPUT             = man
126 MAN_EXTENSION          = .3
127 MAN_LINKS              = NO
128 #---------------------------------------------------------------------------
129 # configuration options related to the XML output
130 #---------------------------------------------------------------------------
131 GENERATE_XML           = NO
132 #---------------------------------------------------------------------------
133 # configuration options related to the preprocessor   
134 #---------------------------------------------------------------------------
135 ENABLE_PREPROCESSING   = NO
136 MACRO_EXPANSION        = NO
137 EXPAND_ONLY_PREDEF     = NO
138 SEARCH_INCLUDES        = YES
139 INCLUDE_PATH           = 
140 INCLUDE_FILE_PATTERNS  = 
141 PREDEFINED             = 
142 EXPAND_AS_DEFINED      = 
143 SKIP_FUNCTION_MACROS   = YES
144 #---------------------------------------------------------------------------
145 # configuration::additions related to external references   
146 #---------------------------------------------------------------------------
147 TAGFILES               = 
148 GENERATE_TAGFILE       = 
149 ALLEXTERNALS           = NO
150 PERL_PATH              = /usr/bin/perl
151 #---------------------------------------------------------------------------
152 # configuration options related to the dot tool   
153 #---------------------------------------------------------------------------
154 HAVE_DOT               = NO
155 CLASS_GRAPH            = YES
156 COLLABORATION_GRAPH    = YES
157 TEMPLATE_RELATIONS     = YES
158 INCLUDE_GRAPH          = YES
159 INCLUDED_BY_GRAPH      = YES
160 GRAPHICAL_HIERARCHY    = YES
161 DOT_PATH               = 
162 DOTFILE_DIRS           = 
163 MAX_DOT_GRAPH_WIDTH    = 1024
164 MAX_DOT_GRAPH_HEIGHT   = 1024
165 GENERATE_LEGEND        = YES
166 DOT_CLEANUP            = YES
167 #---------------------------------------------------------------------------
168 # configuration::additions related to the search engine   
169 #---------------------------------------------------------------------------
170 SEARCHENGINE           = NO
171 CGI_NAME               = search.cgi
172 CGI_URL                = 
173 DOC_URL                = 
174 DOC_ABSPATH            = 
175 BIN_ABSPATH            = /usr/local/bin/
176 EXT_DOC_PATHS          =