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