4f7e1d86bc6f195a42b5a9d851b95fa0d6c2081e
[privoxy.git] / doc / Doxyfile
1 # Doxyfile 1.2.13-20020210
2
3 #---------------------------------------------------------------------------
4 # General configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = "Privoxy 3.1.1"
7 PROJECT_NUMBER         = 
8 OUTPUT_DIRECTORY       = "dox"
9 OUTPUT_LANGUAGE        = English
10 EXTRACT_ALL            = NO
11 EXTRACT_PRIVATE        = NO
12 EXTRACT_STATIC         = YES
13 EXTRACT_LOCAL_CLASSES  = YES
14 HIDE_UNDOC_MEMBERS     = NO
15 HIDE_UNDOC_CLASSES     = NO
16 BRIEF_MEMBER_DESC      = NO
17 REPEAT_BRIEF           = YES
18 ALWAYS_DETAILED_SEC    = YES
19 INLINE_INHERITED_MEMB  = NO
20 FULL_PATH_NAMES        = NO
21 STRIP_FROM_PATH        = 
22 INTERNAL_DOCS          = NO
23 STRIP_CODE_COMMENTS    = NO
24 CASE_SENSE_NAMES       = YES
25 SHORT_NAMES            = NO
26 HIDE_SCOPE_NAMES       = NO
27 VERBATIM_HEADERS       = YES
28 SHOW_INCLUDE_FILES     = NO
29 JAVADOC_AUTOBRIEF      = YES
30 INHERIT_DOCS           = YES
31 INLINE_INFO            = YES
32 SORT_MEMBER_DOCS       = YES
33 DISTRIBUTE_GROUP_DOC   = NO
34 TAB_SIZE               = 8
35 GENERATE_TODOLIST      = YES
36 GENERATE_TESTLIST      = YES
37 GENERATE_BUGLIST       = YES
38 ALIASES                = 
39 ENABLED_SECTIONS       = 
40 MAX_INITIALIZER_LINES  = 30
41 OPTIMIZE_OUTPUT_FOR_C  = YES
42 SHOW_USED_FILES        = YES
43 #---------------------------------------------------------------------------
44 # configuration options related to warning and progress messages
45 #---------------------------------------------------------------------------
46 QUIET                  = YES
47 WARNINGS               = YES
48 WARN_IF_UNDOCUMENTED   = YES
49 WARN_FORMAT            = "$file:$line: $text"
50 WARN_LOGFILE           = 
51 #---------------------------------------------------------------------------
52 # configuration options related to the input files
53 #---------------------------------------------------------------------------
54 INPUT                  = "../src/"
55 FILE_PATTERNS          = *.c \
56                          *.h
57 RECURSIVE              = NO
58 EXCLUDE                = 
59 EXCLUDE_SYMLINKS       = NO
60 EXCLUDE_PATTERNS       = config.h
61 EXAMPLE_PATH           = 
62 EXAMPLE_PATTERNS       = 
63 EXAMPLE_RECURSIVE      = NO
64 IMAGE_PATH             = 
65 INPUT_FILTER           = 
66 FILTER_SOURCE_FILES    = NO
67 #---------------------------------------------------------------------------
68 # configuration options related to source browsing
69 #---------------------------------------------------------------------------
70 SOURCE_BROWSER         = NO
71 INLINE_SOURCES         = NO
72 REFERENCED_BY_RELATION = YES
73 REFERENCES_RELATION    = YES
74 #---------------------------------------------------------------------------
75 # configuration options related to the alphabetical class index
76 #---------------------------------------------------------------------------
77 ALPHABETICAL_INDEX     = YES
78 COLS_IN_ALPHA_INDEX    = 1
79 IGNORE_PREFIX          = 
80 #---------------------------------------------------------------------------
81 # configuration options related to the HTML output
82 #---------------------------------------------------------------------------
83 GENERATE_HTML          = YES
84 HTML_OUTPUT            = html
85 HTML_FILE_EXTENSION    = .html
86 HTML_HEADER            = 
87 HTML_FOOTER            = 
88 HTML_STYLESHEET        = 
89 HTML_ALIGN_MEMBERS     = YES
90 GENERATE_HTMLHELP      = NO
91 GENERATE_CHI           = NO
92 BINARY_TOC             = NO
93 TOC_EXPAND             = NO
94 DISABLE_INDEX          = NO
95 ENUM_VALUES_PER_LINE   = 4
96 GENERATE_TREEVIEW      = YES
97 TREEVIEW_WIDTH         = 250
98 #---------------------------------------------------------------------------
99 # configuration options related to the LaTeX output
100 #---------------------------------------------------------------------------
101 GENERATE_LATEX         = NO
102 LATEX_OUTPUT           = latex
103 LATEX_CMD_NAME         = latex
104 MAKEINDEX_CMD_NAME     = makeindex
105 COMPACT_LATEX          = NO
106 PAPER_TYPE             = a4wide
107 EXTRA_PACKAGES         = 
108 LATEX_HEADER           = 
109 PDF_HYPERLINKS         = NO
110 USE_PDFLATEX           = NO
111 LATEX_BATCHMODE        = NO
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           = YES
132 #---------------------------------------------------------------------------
133 # configuration options for the AutoGen Definitions output
134 #---------------------------------------------------------------------------
135 GENERATE_AUTOGEN_DEF   = NO
136 #---------------------------------------------------------------------------
137 # Configuration options related to the preprocessor   
138 #---------------------------------------------------------------------------
139 ENABLE_PREPROCESSING   = NO
140 MACRO_EXPANSION        = NO
141 EXPAND_ONLY_PREDEF     = NO
142 SEARCH_INCLUDES        = YES
143 INCLUDE_PATH           = 
144 INCLUDE_FILE_PATTERNS  = 
145 PREDEFINED             = 
146 EXPAND_AS_DEFINED      = 
147 SKIP_FUNCTION_MACROS   = YES
148 #---------------------------------------------------------------------------
149 # Configuration::addtions related to external references   
150 #---------------------------------------------------------------------------
151 TAGFILES               = 
152 GENERATE_TAGFILE       = 
153 ALLEXTERNALS           = NO
154 EXTERNAL_GROUPS        = YES
155 PERL_PATH              = /usr/bin/perl
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_IMAGE_FORMAT       = gif
169 DOT_PATH               = 
170 DOTFILE_DIRS           = 
171 MAX_DOT_GRAPH_WIDTH    = 1024
172 MAX_DOT_GRAPH_HEIGHT   = 1024
173 GENERATE_LEGEND        = YES
174 DOT_CLEANUP            = YES
175 #---------------------------------------------------------------------------
176 # Configuration::addtions related to the search engine   
177 #---------------------------------------------------------------------------
178 SEARCHENGINE           = NO
179 CGI_NAME               = search.cgi
180 CGI_URL                = 
181 DOC_URL                = 
182 DOC_ABSPATH            = 
183 BIN_ABSPATH            = /usr/local/bin/
184 EXT_DOC_PATHS          =