Update progress document.
[htmlpurifier.git] / Doxyfile
blobbfdd6b5d9dea3da14e26b874d58f8483fefaffcb
1 # Doxyfile 1.4.7
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = HTMLPurifier
7 PROJECT_NUMBER         = trunk
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 EXAMPLE_PATH           = 
93 EXAMPLE_PATTERNS       = *
94 EXAMPLE_RECURSIVE      = NO
95 IMAGE_PATH             = 
96 INPUT_FILTER           = 
97 FILTER_PATTERNS        = 
98 FILTER_SOURCE_FILES    = NO
99 #---------------------------------------------------------------------------
100 # configuration options related to source browsing
101 #---------------------------------------------------------------------------
102 SOURCE_BROWSER         = YES
103 INLINE_SOURCES         = NO
104 STRIP_CODE_COMMENTS    = YES
105 REFERENCED_BY_RELATION = YES
106 REFERENCES_RELATION    = YES
107 REFERENCES_LINK_SOURCE = YES
108 USE_HTAGS              = NO
109 VERBATIM_HEADERS       = YES
110 #---------------------------------------------------------------------------
111 # configuration options related to the alphabetical class index
112 #---------------------------------------------------------------------------
113 ALPHABETICAL_INDEX     = NO
114 COLS_IN_ALPHA_INDEX    = 5
115 IGNORE_PREFIX          = 
116 #---------------------------------------------------------------------------
117 # configuration options related to the HTML output
118 #---------------------------------------------------------------------------
119 GENERATE_HTML          = YES
120 HTML_OUTPUT            = html
121 HTML_FILE_EXTENSION    = .html
122 HTML_HEADER            = 
123 HTML_FOOTER            = 
124 HTML_STYLESHEET        = 
125 HTML_ALIGN_MEMBERS     = YES
126 GENERATE_HTMLHELP      = NO
127 CHM_FILE               = 
128 HHC_LOCATION           = 
129 GENERATE_CHI           = NO
130 BINARY_TOC             = NO
131 TOC_EXPAND             = NO
132 DISABLE_INDEX          = NO
133 ENUM_VALUES_PER_LINE   = 4
134 GENERATE_TREEVIEW      = YES
135 TREEVIEW_WIDTH         = 250
136 #---------------------------------------------------------------------------
137 # configuration options related to the LaTeX output
138 #---------------------------------------------------------------------------
139 GENERATE_LATEX         = NO
140 LATEX_OUTPUT           = latex
141 LATEX_CMD_NAME         = latex
142 MAKEINDEX_CMD_NAME     = makeindex
143 COMPACT_LATEX          = NO
144 PAPER_TYPE             = a4wide
145 EXTRA_PACKAGES         = 
146 LATEX_HEADER           = 
147 PDF_HYPERLINKS         = YES
148 USE_PDFLATEX           = YES
149 LATEX_BATCHMODE        = NO
150 LATEX_HIDE_INDICES     = NO
151 #---------------------------------------------------------------------------
152 # configuration options related to the RTF output
153 #---------------------------------------------------------------------------
154 GENERATE_RTF           = NO
155 RTF_OUTPUT             = rtf
156 COMPACT_RTF            = NO
157 RTF_HYPERLINKS         = NO
158 RTF_STYLESHEET_FILE    = 
159 RTF_EXTENSIONS_FILE    = 
160 #---------------------------------------------------------------------------
161 # configuration options related to the man page output
162 #---------------------------------------------------------------------------
163 GENERATE_MAN           = NO
164 MAN_OUTPUT             = man
165 MAN_EXTENSION          = .3
166 MAN_LINKS              = NO
167 #---------------------------------------------------------------------------
168 # configuration options related to the XML output
169 #---------------------------------------------------------------------------
170 GENERATE_XML           = NO
171 XML_OUTPUT             = xml
172 XML_SCHEMA             = 
173 XML_DTD                = 
174 XML_PROGRAMLISTING     = YES
175 #---------------------------------------------------------------------------
176 # configuration options for the AutoGen Definitions output
177 #---------------------------------------------------------------------------
178 GENERATE_AUTOGEN_DEF   = NO
179 #---------------------------------------------------------------------------
180 # configuration options related to the Perl module output
181 #---------------------------------------------------------------------------
182 GENERATE_PERLMOD       = NO
183 PERLMOD_LATEX          = NO
184 PERLMOD_PRETTY         = YES
185 PERLMOD_MAKEVAR_PREFIX = 
186 #---------------------------------------------------------------------------
187 # Configuration options related to the preprocessor   
188 #---------------------------------------------------------------------------
189 ENABLE_PREPROCESSING   = YES
190 MACRO_EXPANSION        = NO
191 EXPAND_ONLY_PREDEF     = NO
192 SEARCH_INCLUDES        = YES
193 INCLUDE_PATH           = 
194 INCLUDE_FILE_PATTERNS  = 
195 PREDEFINED             = 
196 EXPAND_AS_DEFINED      = 
197 SKIP_FUNCTION_MACROS   = YES
198 #---------------------------------------------------------------------------
199 # Configuration::additions related to external references   
200 #---------------------------------------------------------------------------
201 TAGFILES               = 
202 GENERATE_TAGFILE       = 
203 ALLEXTERNALS           = NO
204 EXTERNAL_GROUPS        = YES
205 PERL_PATH              = /usr/bin/perl
206 #---------------------------------------------------------------------------
207 # Configuration options related to the dot tool   
208 #---------------------------------------------------------------------------
209 CLASS_DIAGRAMS         = YES
210 HIDE_UNDOC_RELATIONS   = YES
211 HAVE_DOT               = NO
212 CLASS_GRAPH            = YES
213 COLLABORATION_GRAPH    = YES
214 GROUP_GRAPHS           = YES
215 UML_LOOK               = NO
216 TEMPLATE_RELATIONS     = NO
217 INCLUDE_GRAPH          = YES
218 INCLUDED_BY_GRAPH      = YES
219 CALL_GRAPH             = NO
220 CALLER_GRAPH           = NO
221 GRAPHICAL_HIERARCHY    = YES
222 DIRECTORY_GRAPH        = YES
223 DOT_IMAGE_FORMAT       = png
224 DOT_PATH               = 
225 DOTFILE_DIRS           = 
226 MAX_DOT_GRAPH_WIDTH    = 1024
227 MAX_DOT_GRAPH_HEIGHT   = 1024
228 MAX_DOT_GRAPH_DEPTH    = 1000
229 DOT_TRANSPARENT        = NO
230 DOT_MULTI_TARGETS      = NO
231 GENERATE_LEGEND        = YES
232 DOT_CLEANUP            = YES
233 #---------------------------------------------------------------------------
234 # Configuration::additions related to the search engine   
235 #---------------------------------------------------------------------------
236 SEARCHENGINE           = NO