Release 2.1.0, merged in 1313 to HEAD.
[htmlpurifier.git] / Doxyfile
blob98454090de771990791c49a13da119e5cc9ab5d7
1 # Doxyfile 1.4.7
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = HTML Purifier
7 PROJECT_NUMBER         = 2.1.0
8 OUTPUT_DIRECTORY       = "C:/Documents and Settings/Edward/My Documents/My Webs/htmlpurifier/docs/doxygen"
9 CREATE_SUBDIRS         = NO
10 OUTPUT_LANGUAGE        = English
11 USE_WINDOWS_ENCODING   = NO
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       = "The $name class" \
15                          "The $name widget" \
16                          "The $name file" \
17                          is \
18                          provides \
19                          specifies \
20                          contains \
21                          represents \
22                          a \
23                          an \
24                          the
25 ALWAYS_DETAILED_SEC    = NO
26 INLINE_INHERITED_MEMB  = NO
27 FULL_PATH_NAMES        = YES
28 STRIP_FROM_PATH        = "C:/Documents and Settings/Edward/My Documents/My Webs/htmlpurifier"
29 STRIP_FROM_INC_PATH    = 
30 SHORT_NAMES            = NO
31 JAVADOC_AUTOBRIEF      = YES
32 MULTILINE_CPP_IS_BRIEF = NO
33 DETAILS_AT_TOP         = NO
34 INHERIT_DOCS           = YES
35 SEPARATE_MEMBER_PAGES  = NO
36 TAB_SIZE               = 4
37 ALIASES                = 
38 OPTIMIZE_OUTPUT_FOR_C  = NO
39 OPTIMIZE_OUTPUT_JAVA   = NO
40 BUILTIN_STL_SUPPORT    = NO
41 DISTRIBUTE_GROUP_DOC   = NO
42 SUBGROUPING            = YES
43 #---------------------------------------------------------------------------
44 # Build related configuration options
45 #---------------------------------------------------------------------------
46 EXTRACT_ALL            = YES
47 EXTRACT_PRIVATE        = YES
48 EXTRACT_STATIC         = YES
49 EXTRACT_LOCAL_CLASSES  = YES
50 EXTRACT_LOCAL_METHODS  = NO
51 HIDE_UNDOC_MEMBERS     = NO
52 HIDE_UNDOC_CLASSES     = NO
53 HIDE_FRIEND_COMPOUNDS  = NO
54 HIDE_IN_BODY_DOCS      = NO
55 INTERNAL_DOCS          = NO
56 CASE_SENSE_NAMES       = YES
57 HIDE_SCOPE_NAMES       = NO
58 SHOW_INCLUDE_FILES     = YES
59 INLINE_INFO            = YES
60 SORT_MEMBER_DOCS       = YES
61 SORT_BRIEF_DOCS        = NO
62 SORT_BY_SCOPE_NAME     = NO
63 GENERATE_TODOLIST      = YES
64 GENERATE_TESTLIST      = YES
65 GENERATE_BUGLIST       = YES
66 GENERATE_DEPRECATEDLIST= YES
67 ENABLED_SECTIONS       = 
68 MAX_INITIALIZER_LINES  = 30
69 SHOW_USED_FILES        = YES
70 SHOW_DIRECTORIES       = NO
71 FILE_VERSION_FILTER    = 
72 #---------------------------------------------------------------------------
73 # configuration options related to warning and progress messages
74 #---------------------------------------------------------------------------
75 QUIET                  = NO
76 WARNINGS               = YES
77 WARN_IF_UNDOCUMENTED   = YES
78 WARN_IF_DOC_ERROR      = YES
79 WARN_NO_PARAMDOC       = NO
80 WARN_FORMAT            = "$file:$line: $text"
81 WARN_LOGFILE           = 
82 #---------------------------------------------------------------------------
83 # configuration options related to the input files
84 #---------------------------------------------------------------------------
85 INPUT                  = "C:/Documents and Settings/Edward/My Documents/My Webs/htmlpurifier"
86 FILE_PATTERNS          = *.php
87 RECURSIVE              = YES
88 EXCLUDE                = 
89 EXCLUDE_SYMLINKS       = NO
90 EXCLUDE_PATTERNS       = */tests/* \
91                          */benchmarks/* \
92                          */docs/* \
93                          */test-settings.php \
94                          */configdoc/* \
95                          */test-settings.php \
96                          */maintenance/* \
97                          */smoketests/*
98 EXAMPLE_PATH           = 
99 EXAMPLE_PATTERNS       = *
100 EXAMPLE_RECURSIVE      = NO
101 IMAGE_PATH             = 
102 INPUT_FILTER           = 
103 FILTER_PATTERNS        = 
104 FILTER_SOURCE_FILES    = NO
105 #---------------------------------------------------------------------------
106 # configuration options related to source browsing
107 #---------------------------------------------------------------------------
108 SOURCE_BROWSER         = YES
109 INLINE_SOURCES         = NO
110 STRIP_CODE_COMMENTS    = YES
111 REFERENCED_BY_RELATION = YES
112 REFERENCES_RELATION    = YES
113 REFERENCES_LINK_SOURCE = YES
114 USE_HTAGS              = NO
115 VERBATIM_HEADERS       = YES
116 #---------------------------------------------------------------------------
117 # configuration options related to the alphabetical class index
118 #---------------------------------------------------------------------------
119 ALPHABETICAL_INDEX     = NO
120 COLS_IN_ALPHA_INDEX    = 5
121 IGNORE_PREFIX          = 
122 #---------------------------------------------------------------------------
123 # configuration options related to the HTML output
124 #---------------------------------------------------------------------------
125 GENERATE_HTML          = YES
126 HTML_OUTPUT            = html
127 HTML_FILE_EXTENSION    = .html
128 HTML_HEADER            = 
129 HTML_FOOTER            = 
130 HTML_STYLESHEET        = 
131 HTML_ALIGN_MEMBERS     = YES
132 GENERATE_HTMLHELP      = NO
133 CHM_FILE               = 
134 HHC_LOCATION           = 
135 GENERATE_CHI           = NO
136 BINARY_TOC             = NO
137 TOC_EXPAND             = NO
138 DISABLE_INDEX          = NO
139 ENUM_VALUES_PER_LINE   = 4
140 GENERATE_TREEVIEW      = YES
141 TREEVIEW_WIDTH         = 250
142 #---------------------------------------------------------------------------
143 # configuration options related to the LaTeX output
144 #---------------------------------------------------------------------------
145 GENERATE_LATEX         = NO
146 LATEX_OUTPUT           = latex
147 LATEX_CMD_NAME         = latex
148 MAKEINDEX_CMD_NAME     = makeindex
149 COMPACT_LATEX          = NO
150 PAPER_TYPE             = a4wide
151 EXTRA_PACKAGES         = 
152 LATEX_HEADER           = 
153 PDF_HYPERLINKS         = YES
154 USE_PDFLATEX           = YES
155 LATEX_BATCHMODE        = NO
156 LATEX_HIDE_INDICES     = NO
157 #---------------------------------------------------------------------------
158 # configuration options related to the RTF output
159 #---------------------------------------------------------------------------
160 GENERATE_RTF           = NO
161 RTF_OUTPUT             = rtf
162 COMPACT_RTF            = NO
163 RTF_HYPERLINKS         = NO
164 RTF_STYLESHEET_FILE    = 
165 RTF_EXTENSIONS_FILE    = 
166 #---------------------------------------------------------------------------
167 # configuration options related to the man page output
168 #---------------------------------------------------------------------------
169 GENERATE_MAN           = NO
170 MAN_OUTPUT             = man
171 MAN_EXTENSION          = .3
172 MAN_LINKS              = NO
173 #---------------------------------------------------------------------------
174 # configuration options related to the XML output
175 #---------------------------------------------------------------------------
176 GENERATE_XML           = NO
177 XML_OUTPUT             = xml
178 XML_SCHEMA             = 
179 XML_DTD                = 
180 XML_PROGRAMLISTING     = YES
181 #---------------------------------------------------------------------------
182 # configuration options for the AutoGen Definitions output
183 #---------------------------------------------------------------------------
184 GENERATE_AUTOGEN_DEF   = NO
185 #---------------------------------------------------------------------------
186 # configuration options related to the Perl module output
187 #---------------------------------------------------------------------------
188 GENERATE_PERLMOD       = NO
189 PERLMOD_LATEX          = NO
190 PERLMOD_PRETTY         = YES
191 PERLMOD_MAKEVAR_PREFIX = 
192 #---------------------------------------------------------------------------
193 # Configuration options related to the preprocessor   
194 #---------------------------------------------------------------------------
195 ENABLE_PREPROCESSING   = YES
196 MACRO_EXPANSION        = NO
197 EXPAND_ONLY_PREDEF     = NO
198 SEARCH_INCLUDES        = YES
199 INCLUDE_PATH           = 
200 INCLUDE_FILE_PATTERNS  = 
201 PREDEFINED             = 
202 EXPAND_AS_DEFINED      = 
203 SKIP_FUNCTION_MACROS   = YES
204 #---------------------------------------------------------------------------
205 # Configuration::additions related to external references   
206 #---------------------------------------------------------------------------
207 TAGFILES               = 
208 GENERATE_TAGFILE       = 
209 ALLEXTERNALS           = NO
210 EXTERNAL_GROUPS        = YES
211 PERL_PATH              = /usr/bin/perl
212 #---------------------------------------------------------------------------
213 # Configuration options related to the dot tool   
214 #---------------------------------------------------------------------------
215 CLASS_DIAGRAMS         = YES
216 HIDE_UNDOC_RELATIONS   = YES
217 HAVE_DOT               = NO
218 CLASS_GRAPH            = YES
219 COLLABORATION_GRAPH    = YES
220 GROUP_GRAPHS           = YES
221 UML_LOOK               = NO
222 TEMPLATE_RELATIONS     = NO
223 INCLUDE_GRAPH          = YES
224 INCLUDED_BY_GRAPH      = YES
225 CALL_GRAPH             = NO
226 CALLER_GRAPH           = NO
227 GRAPHICAL_HIERARCHY    = YES
228 DIRECTORY_GRAPH        = YES
229 DOT_IMAGE_FORMAT       = png
230 DOT_PATH               = 
231 DOTFILE_DIRS           = 
232 MAX_DOT_GRAPH_WIDTH    = 1024
233 MAX_DOT_GRAPH_HEIGHT   = 1024
234 MAX_DOT_GRAPH_DEPTH    = 1000
235 DOT_TRANSPARENT        = NO
236 DOT_MULTI_TARGETS      = NO
237 GENERATE_LEGEND        = YES
238 DOT_CLEANUP            = YES
239 #---------------------------------------------------------------------------
240 # Configuration::additions related to the search engine   
241 #---------------------------------------------------------------------------
242 SEARCHENGINE           = NO