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