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