3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME = $(PROJECT)
7 PROJECT_NUMBER = $(VERSION)
8 OUTPUT_DIRECTORY = $(DOCDIR)
10 OUTPUT_LANGUAGE = English
11 USE_WINDOWS_ENCODING = NO
12 BRIEF_MEMBER_DESC = YES
15 ALWAYS_DETAILED_SEC = NO
16 INLINE_INHERITED_MEMB = NO
17 STRIP_FROM_INC_PATH = $(SRCDIR)
19 STRIP_FROM_PATH = $(SRCDIR)
21 JAVADOC_AUTOBRIEF = YES
22 MULTILINE_CPP_IS_BRIEF = NO
25 DISTRIBUTE_GROUP_DOC = NO
28 OPTIMIZE_OUTPUT_FOR_C = YES
29 OPTIMIZE_OUTPUT_JAVA = NO
31 #---------------------------------------------------------------------------
32 # Build related configuration options
33 #---------------------------------------------------------------------------
37 EXTRACT_LOCAL_CLASSES = YES
38 EXTRACT_LOCAL_METHODS = NO
39 HIDE_UNDOC_MEMBERS = NO
40 HIDE_UNDOC_CLASSES = NO
41 HIDE_FRIEND_COMPOUNDS = NO
42 HIDE_IN_BODY_DOCS = NO
46 SHOW_INCLUDE_FILES = YES
48 SORT_MEMBER_DOCS = YES
50 SORT_BY_SCOPE_NAME = NO
51 GENERATE_TODOLIST = YES
52 GENERATE_TESTLIST = YES
53 GENERATE_BUGLIST = YES
54 GENERATE_DEPRECATEDLIST= YES
56 MAX_INITIALIZER_LINES = 30
59 #---------------------------------------------------------------------------
60 # configuration options related to warning and progress messages
61 #---------------------------------------------------------------------------
64 WARN_IF_UNDOCUMENTED = YES
65 WARN_IF_DOC_ERROR = YES
66 WARN_FORMAT = "$file:$line: $text"
68 #---------------------------------------------------------------------------
69 # configuration options related to the input files
70 #---------------------------------------------------------------------------
77 EXAMPLE_PATH = $(EXAMPLE_PATH)
78 EXAMPLE_PATTERNS = $(EXAMPLE_PATTERNS)
79 EXAMPLE_RECURSIVE = NO
82 FILTER_SOURCE_FILES = NO
83 #---------------------------------------------------------------------------
84 # configuration options related to source browsing
85 #---------------------------------------------------------------------------
88 STRIP_CODE_COMMENTS = YES
89 REFERENCED_BY_RELATION = YES
90 REFERENCES_RELATION = YES
91 VERBATIM_HEADERS = YES
92 #---------------------------------------------------------------------------
93 # configuration options related to the alphabetical class index
94 #---------------------------------------------------------------------------
95 ALPHABETICAL_INDEX = YES
96 COLS_IN_ALPHA_INDEX = 5
97 IGNORE_PREFIX = Catta CATTA_ catta_
98 #---------------------------------------------------------------------------
99 # configuration options related to the HTML output
100 #---------------------------------------------------------------------------
101 GENERATE_HTML = $(GENERATE_HTML)
103 HTML_FILE_EXTENSION = .html
107 HTML_ALIGN_MEMBERS = YES
108 GENERATE_HTMLHELP = $(GENERATE_CHM)
109 CHM_FILE = ../$(PROJECT).chm
110 HHC_LOCATION = $(HHC_PATH)
111 GENERATE_CHI = $(GENERATE_CHI)
115 ENUM_VALUES_PER_LINE = 1
116 GENERATE_TREEVIEW = YES
118 #---------------------------------------------------------------------------
119 # configuration options related to the LaTeX output
120 #---------------------------------------------------------------------------
121 GENERATE_LATEX = $(GENERATE_LATEX)
123 LATEX_CMD_NAME = latex
124 MAKEINDEX_CMD_NAME = makeindex
126 PAPER_TYPE = $(PAPER_SIZE)
131 LATEX_BATCHMODE = YES
132 LATEX_HIDE_INDICES = NO
133 #---------------------------------------------------------------------------
134 # configuration options related to the RTF output
135 #---------------------------------------------------------------------------
136 GENERATE_RTF = $(GENERATE_RTF)
140 RTF_STYLESHEET_FILE =
141 RTF_EXTENSIONS_FILE =
142 #---------------------------------------------------------------------------
143 # configuration options related to the man page output
144 #---------------------------------------------------------------------------
145 GENERATE_MAN = $(GENERATE_MAN)
149 #---------------------------------------------------------------------------
150 # configuration options related to the XML output
151 #---------------------------------------------------------------------------
152 GENERATE_XML = $(GENERATE_XML)
156 XML_PROGRAMLISTING = YES
157 #---------------------------------------------------------------------------
158 # configuration options for the AutoGen Definitions output
159 #---------------------------------------------------------------------------
160 GENERATE_AUTOGEN_DEF = NO
161 #---------------------------------------------------------------------------
162 # configuration options related to the Perl module output
163 #---------------------------------------------------------------------------
164 GENERATE_PERLMOD = NO
167 PERLMOD_MAKEVAR_PREFIX =
168 #---------------------------------------------------------------------------
169 # Configuration options related to the preprocessor
170 #---------------------------------------------------------------------------
171 ENABLE_PREPROCESSING = YES
172 MACRO_EXPANSION = YES
173 EXPAND_ONLY_PREDEF = YES
174 SEARCH_INCLUDES = YES
176 INCLUDE_FILE_PATTERNS =
177 PREDEFINED = "DOXYGEN_SHOULD_SKIP_THIS" "CATTA_C_DECL_BEGIN=" "CATTA_C_DECL_END="
179 SKIP_FUNCTION_MACROS = YES
180 #---------------------------------------------------------------------------
181 # Configuration::additions related to external references
182 #---------------------------------------------------------------------------
184 GENERATE_TAGFILE = $(DOCDIR)/$(PROJECT).tag
186 EXTERNAL_GROUPS = YES
187 PERL_PATH = $(PERL_PATH)
188 #---------------------------------------------------------------------------
189 # Configuration options related to the dot tool
190 #---------------------------------------------------------------------------
192 HIDE_UNDOC_RELATIONS = NO
193 HAVE_DOT = $(HAVE_DOT)
195 COLLABORATION_GRAPH = NO
197 TEMPLATE_RELATIONS = NO
199 INCLUDED_BY_GRAPH = NO
201 GRAPHICAL_HIERARCHY = NO
202 DOT_IMAGE_FORMAT = png
203 DOT_PATH = $(DOT_PATH)
205 MAX_DOT_GRAPH_WIDTH = 1024
206 MAX_DOT_GRAPH_HEIGHT = 1024
207 MAX_DOT_GRAPH_DEPTH = 0
208 GENERATE_LEGEND = YES
210 #---------------------------------------------------------------------------
211 # Configuration::additions related to the search engine
212 #---------------------------------------------------------------------------