2003-02-19 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / Doxyfile.in
1 # Doxyfile 0.1
2
3 #---------------------------------------------------------------------------
4 # General configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = D-BUS
7 PROJECT_NUMBER         = @VERSION@
8 OUTPUT_DIRECTORY       = doc/api
9 OUTPUT_LANGUAGE        = English
10 EXTRACT_ALL            = NO
11 EXTRACT_PRIVATE        = NO
12 EXTRACT_STATIC         = NO
13 HIDE_UNDOC_MEMBERS     = NO
14 HIDE_UNDOC_CLASSES     = NO
15 BRIEF_MEMBER_DESC      = YES
16 REPEAT_BRIEF           = YES
17 ALWAYS_DETAILED_SEC    = NO
18 FULL_PATH_NAMES        = NO
19 STRIP_FROM_PATH        = 
20 INTERNAL_DOCS          = NO
21 STRIP_CODE_COMMENTS    = YES
22 CASE_SENSE_NAMES       = YES
23 SHORT_NAMES            = NO
24 HIDE_SCOPE_NAMES       = NO
25 VERBATIM_HEADERS       = YES
26 SHOW_INCLUDE_FILES     = YES
27 JAVADOC_AUTOBRIEF      = YES
28 INHERIT_DOCS           = YES
29 INLINE_INFO            = YES
30 SORT_MEMBER_DOCS       = YES
31 DISTRIBUTE_GROUP_DOC   = NO
32 TAB_SIZE               = 8
33 GENERATE_TODOLIST      = YES
34 GENERATE_TESTLIST      = YES
35 GENERATE_BUGLIST       = YES
36 ALIASES                = 
37 ENABLED_SECTIONS       = 
38 MAX_INITIALIZER_LINES  = 30
39 OPTIMIZE_OUTPUT_FOR_C  = YES
40 SHOW_USED_FILES        = YES
41 #---------------------------------------------------------------------------
42 # configuration options related to warning and progress messages
43 #---------------------------------------------------------------------------
44 QUIET                  = YES
45 WARNINGS               = YES
46 WARN_IF_UNDOCUMENTED   = YES
47 WARN_FORMAT            = 
48 WARN_LOGFILE           = 
49 #---------------------------------------------------------------------------
50 # configuration options related to the input files
51 #---------------------------------------------------------------------------
52 INPUT                  = dbus bus
53 FILE_PATTERNS          = *.c *.h
54 RECURSIVE              = YES
55 #EXCLUDE                = test
56
57 # If the value of the INPUT tag contains directories, you can use the 
58 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
59 # certain files from those directories.
60
61 EXCLUDE_PATTERNS       = Makefile.* ChangeLog CHANGES CHANGES.* README \
62                          README.* *.png AUTHORS DESIGN DESIGN.* *.desktop \
63                          DESKTOP* COMMENTS HOWTO magic NOTES TODO THANKS
64
65 # The EXAMPLE_PATH tag can be used to specify one or more files or 
66 # directories that contain example code fragments that are included (see 
67 # the \include command).
68
69 EXAMPLE_PATH           = 
70 EXAMPLE_PATTERNS       = 
71 EXAMPLE_RECURSIVE      = NO
72 IMAGE_PATH             = 
73 INPUT_FILTER           = 
74 FILTER_SOURCE_FILES    = NO
75 #---------------------------------------------------------------------------
76 # configuration options related to source browsing
77 #---------------------------------------------------------------------------
78 SOURCE_BROWSER         = YES
79 INLINE_SOURCES         = NO
80 REFERENCED_BY_RELATION = YES
81 REFERENCES_RELATION    = YES
82 #---------------------------------------------------------------------------
83 # configuration options related to the alphabetical class index
84 #---------------------------------------------------------------------------
85 ALPHABETICAL_INDEX     = NO
86 COLS_IN_ALPHA_INDEX    = 5
87 IGNORE_PREFIX          = 
88 #---------------------------------------------------------------------------
89 # configuration options related to the HTML output
90 #---------------------------------------------------------------------------
91 GENERATE_HTML          = YES
92 HTML_OUTPUT            = 
93 HTML_HEADER            = 
94 HTML_FOOTER            = 
95 HTML_STYLESHEET        = 
96 HTML_ALIGN_MEMBERS     = YES
97 GENERATE_HTMLHELP      = NO
98 GENERATE_CHI           = NO
99 BINARY_TOC             = NO
100 TOC_EXPAND             = NO
101 DISABLE_INDEX          = NO
102 ENUM_VALUES_PER_LINE   = 4
103 GENERATE_TREEVIEW      = NO
104 TREEVIEW_WIDTH         = 250
105 #---------------------------------------------------------------------------
106 # configuration options related to the LaTeX output
107 #---------------------------------------------------------------------------
108 GENERATE_LATEX         = NO
109 LATEX_OUTPUT           = 
110 COMPACT_LATEX          = NO
111 PAPER_TYPE             = a4wide
112 EXTRA_PACKAGES         = 
113 LATEX_HEADER           = 
114 PDF_HYPERLINKS         = NO
115 USE_PDFLATEX           = NO
116 LATEX_BATCHMODE        = NO
117 #---------------------------------------------------------------------------
118 # configuration options related to the RTF output
119 #---------------------------------------------------------------------------
120 GENERATE_RTF           = NO
121 RTF_OUTPUT             = 
122 COMPACT_RTF            = NO
123 RTF_HYPERLINKS         = NO
124 RTF_STYLESHEET_FILE    = 
125 RTF_EXTENSIONS_FILE    = 
126 #---------------------------------------------------------------------------
127 # configuration options related to the man page output
128 #---------------------------------------------------------------------------
129 GENERATE_MAN           = YES
130 MAN_OUTPUT             = man
131 MAN_EXTENSION          = .3dbus
132 MAN_LINKS              = YES
133 #---------------------------------------------------------------------------
134 # configuration options related to the XML output
135 #---------------------------------------------------------------------------
136 GENERATE_XML           = NO
137 #---------------------------------------------------------------------------
138 # Configuration options related to the preprocessor   
139 #---------------------------------------------------------------------------
140 ENABLE_PREPROCESSING   = YES
141 MACRO_EXPANSION        = YES
142 EXPAND_ONLY_PREDEF     = YES
143 SEARCH_INCLUDES        = YES
144 INCLUDE_PATH           = 
145 INCLUDE_FILE_PATTERNS  = 
146 PREDEFINED             = "DBUS_BEGIN_DECLS=" "DBUS_END_DECLS=" "DOXYGEN_SHOULD_SKIP_THIS"
147 EXPAND_AS_DEFINED      = 
148 SKIP_FUNCTION_MACROS   = YES
149 #---------------------------------------------------------------------------
150 # Configuration::addtions related to external references   
151 #---------------------------------------------------------------------------
152 TAGFILES               = 
153 GENERATE_TAGFILE       = 
154 ALLEXTERNALS           = NO
155 PERL_PATH              = 
156 #---------------------------------------------------------------------------
157 # Configuration options related to the dot tool   
158 #---------------------------------------------------------------------------
159 CLASS_DIAGRAMS         = YES
160 HAVE_DOT               = NO
161 CLASS_GRAPH            = YES
162 COLLABORATION_GRAPH    = YES
163 TEMPLATE_RELATIONS     = YES
164 HIDE_UNDOC_RELATIONS   = YES
165 INCLUDE_GRAPH          = YES
166 INCLUDED_BY_GRAPH      = YES
167 GRAPHICAL_HIERARCHY    = YES
168 DOT_PATH               = 
169 DOTFILE_DIRS           = 
170 MAX_DOT_GRAPH_WIDTH    = 640
171 MAX_DOT_GRAPH_HEIGHT   = 1024
172 GENERATE_LEGEND        = YES
173 DOT_CLEANUP            = YES
174 #---------------------------------------------------------------------------
175 # Configuration::addtions related to the search engine   
176 #---------------------------------------------------------------------------
177 SEARCHENGINE           = NO
178 CGI_NAME               = 
179 CGI_URL                = 
180 DOC_URL                = 
181 DOC_ABSPATH            = 
182 BIN_ABSPATH            = 
183 EXT_DOC_PATHS          =