]> git.cryptolib.org Git - avr-crypto-lib.git/blob - Doxyfile
documentation upgrade; most docu still missing but a first step is done
[avr-crypto-lib.git] / Doxyfile
1 # Doxyfile 1.4.7
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = micro-crypt
7 PROJECT_NUMBER         = 0.001
8 OUTPUT_DIRECTORY       = /home/bg/workspace/micro-crypt/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       = "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        = /home/bg/workspace/micro-crypt/
29 STRIP_FROM_INC_PATH    = 
30 SHORT_NAMES            = NO
31 JAVADOC_AUTOBRIEF      = NO
32 MULTILINE_CPP_IS_BRIEF = NO
33 DETAILS_AT_TOP         = NO
34 INHERIT_DOCS           = YES
35 SEPARATE_MEMBER_PAGES  = NO
36 TAB_SIZE               = 8
37 ALIASES                = 
38 OPTIMIZE_OUTPUT_FOR_C  = YES
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                  = /home/bg/workspace/micro-crypt
86 FILE_PATTERNS          = *.c \
87                          *.cc \
88                          *.cxx \
89                          *.cpp \
90                          *.c++ \
91                          *.d \
92                          *.java \
93                          *.ii \
94                          *.ixx \
95                          *.ipp \
96                          *.i++ \
97                          *.inl \
98                          *.h \
99                          *.hh \
100                          *.hxx \
101                          *.hpp \
102                          *.h++ \
103                          *.idl \
104                          *.odl \
105                          *.cs \
106                          *.php \
107                          *.php3 \
108                          *.inc \
109                          *.m \
110                          *.mm \
111                          *.dox \
112                          *.py \
113                          *.C \
114                          *.CC \
115                          *.C++ \
116                          *.II \
117                          *.I++ \
118                          *.H \
119                          *.HH \
120                          *.H++ \
121                          *.CS \
122                          *.PHP \
123                          *.PHP3 \
124                          *.M \
125                          *.MM \
126                          *.PY
127 RECURSIVE              = NO
128 EXCLUDE                = 
129 EXCLUDE_SYMLINKS       = NO
130 EXCLUDE_PATTERNS       = 
131 EXAMPLE_PATH           = 
132 EXAMPLE_PATTERNS       = *
133 EXAMPLE_RECURSIVE      = NO
134 IMAGE_PATH             = 
135 INPUT_FILTER           = 
136 FILTER_PATTERNS        = 
137 FILTER_SOURCE_FILES    = NO
138 #---------------------------------------------------------------------------
139 # configuration options related to source browsing
140 #---------------------------------------------------------------------------
141 SOURCE_BROWSER         = YES
142 INLINE_SOURCES         = NO
143 STRIP_CODE_COMMENTS    = YES
144 REFERENCED_BY_RELATION = YES
145 REFERENCES_RELATION    = YES
146 REFERENCES_LINK_SOURCE = YES
147 USE_HTAGS              = NO
148 VERBATIM_HEADERS       = YES
149 #---------------------------------------------------------------------------
150 # configuration options related to the alphabetical class index
151 #---------------------------------------------------------------------------
152 ALPHABETICAL_INDEX     = NO
153 COLS_IN_ALPHA_INDEX    = 5
154 IGNORE_PREFIX          = 
155 #---------------------------------------------------------------------------
156 # configuration options related to the HTML output
157 #---------------------------------------------------------------------------
158 GENERATE_HTML          = YES
159 HTML_OUTPUT            = html
160 HTML_FILE_EXTENSION    = .html
161 HTML_HEADER            = 
162 HTML_FOOTER            = 
163 HTML_STYLESHEET        = 
164 HTML_ALIGN_MEMBERS     = YES
165 GENERATE_HTMLHELP      = NO
166 CHM_FILE               = 
167 HHC_LOCATION           = 
168 GENERATE_CHI           = NO
169 BINARY_TOC             = NO
170 TOC_EXPAND             = NO
171 DISABLE_INDEX          = NO
172 ENUM_VALUES_PER_LINE   = 4
173 GENERATE_TREEVIEW      = NO
174 TREEVIEW_WIDTH         = 250
175 #---------------------------------------------------------------------------
176 # configuration options related to the LaTeX output
177 #---------------------------------------------------------------------------
178 GENERATE_LATEX         = YES
179 LATEX_OUTPUT           = latex
180 LATEX_CMD_NAME         = latex
181 MAKEINDEX_CMD_NAME     = makeindex
182 COMPACT_LATEX          = NO
183 PAPER_TYPE             = a4wide
184 EXTRA_PACKAGES         = 
185 LATEX_HEADER           = 
186 PDF_HYPERLINKS         = YES
187 USE_PDFLATEX           = YES
188 LATEX_BATCHMODE        = NO
189 LATEX_HIDE_INDICES     = NO
190 #---------------------------------------------------------------------------
191 # configuration options related to the RTF output
192 #---------------------------------------------------------------------------
193 GENERATE_RTF           = NO
194 RTF_OUTPUT             = rtf
195 COMPACT_RTF            = NO
196 RTF_HYPERLINKS         = NO
197 RTF_STYLESHEET_FILE    = 
198 RTF_EXTENSIONS_FILE    = 
199 #---------------------------------------------------------------------------
200 # configuration options related to the man page output
201 #---------------------------------------------------------------------------
202 GENERATE_MAN           = NO
203 MAN_OUTPUT             = man
204 MAN_EXTENSION          = .3
205 MAN_LINKS              = NO
206 #---------------------------------------------------------------------------
207 # configuration options related to the XML output
208 #---------------------------------------------------------------------------
209 GENERATE_XML           = NO
210 XML_OUTPUT             = xml
211 XML_SCHEMA             = 
212 XML_DTD                = 
213 XML_PROGRAMLISTING     = YES
214 #---------------------------------------------------------------------------
215 # configuration options for the AutoGen Definitions output
216 #---------------------------------------------------------------------------
217 GENERATE_AUTOGEN_DEF   = NO
218 #---------------------------------------------------------------------------
219 # configuration options related to the Perl module output
220 #---------------------------------------------------------------------------
221 GENERATE_PERLMOD       = NO
222 PERLMOD_LATEX          = NO
223 PERLMOD_PRETTY         = YES
224 PERLMOD_MAKEVAR_PREFIX = 
225 #---------------------------------------------------------------------------
226 # Configuration options related to the preprocessor   
227 #---------------------------------------------------------------------------
228 ENABLE_PREPROCESSING   = YES
229 MACRO_EXPANSION        = NO
230 EXPAND_ONLY_PREDEF     = NO
231 SEARCH_INCLUDES        = YES
232 INCLUDE_PATH           = 
233 INCLUDE_FILE_PATTERNS  = 
234 PREDEFINED             = 
235 EXPAND_AS_DEFINED      = 
236 SKIP_FUNCTION_MACROS   = YES
237 #---------------------------------------------------------------------------
238 # Configuration::additions related to external references   
239 #---------------------------------------------------------------------------
240 TAGFILES               = 
241 GENERATE_TAGFILE       = 
242 ALLEXTERNALS           = NO
243 EXTERNAL_GROUPS        = YES
244 PERL_PATH              = /usr/bin/perl
245 #---------------------------------------------------------------------------
246 # Configuration options related to the dot tool   
247 #---------------------------------------------------------------------------
248 CLASS_DIAGRAMS         = NO
249 HIDE_UNDOC_RELATIONS   = YES
250 HAVE_DOT               = YES
251 CLASS_GRAPH            = YES
252 COLLABORATION_GRAPH    = YES
253 GROUP_GRAPHS           = YES
254 UML_LOOK               = NO
255 TEMPLATE_RELATIONS     = NO
256 INCLUDE_GRAPH          = YES
257 INCLUDED_BY_GRAPH      = YES
258 CALL_GRAPH             = YES
259 CALLER_GRAPH           = NO
260 GRAPHICAL_HIERARCHY    = YES
261 DIRECTORY_GRAPH        = YES
262 DOT_IMAGE_FORMAT       = png
263 DOT_PATH               = 
264 DOTFILE_DIRS           = 
265 MAX_DOT_GRAPH_WIDTH    = 1024
266 MAX_DOT_GRAPH_HEIGHT   = 1024
267 MAX_DOT_GRAPH_DEPTH    = 1000
268 DOT_TRANSPARENT        = NO
269 DOT_MULTI_TARGETS      = NO
270 GENERATE_LEGEND        = YES
271 DOT_CLEANUP            = YES
272 #---------------------------------------------------------------------------
273 # Configuration::additions related to the search engine   
274 #---------------------------------------------------------------------------
275 SEARCHENGINE           = NO