source: OGRE/trunk/ogrenew/Docs/src/html.cfg @ 657

Revision 657, 9.0 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1# Doxyfile 1.4.1
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = OGRE
7PROJECT_NUMBER         = 1.0.7
8OUTPUT_DIRECTORY       = ../api/
9CREATE_SUBDIRS         = NO
10OUTPUT_LANGUAGE        = English
11USE_WINDOWS_ENCODING   = YES
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    = YES
26INLINE_INHERITED_MEMB  = YES
27FULL_PATH_NAMES        = NO
28STRIP_FROM_PATH        =
29STRIP_FROM_INC_PATH    =
30SHORT_NAMES            = NO
31JAVADOC_AUTOBRIEF      = YES
32MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP         = NO
34INHERIT_DOCS           = YES
35DISTRIBUTE_GROUP_DOC   = NO
36TAB_SIZE               = 4
37ALIASES                =
38OPTIMIZE_OUTPUT_FOR_C  = NO
39OPTIMIZE_OUTPUT_JAVA   = NO
40SUBGROUPING            = YES
41#---------------------------------------------------------------------------
42# Build related configuration options
43#---------------------------------------------------------------------------
44EXTRACT_ALL            = YES
45EXTRACT_PRIVATE        = YES
46EXTRACT_STATIC         = YES
47EXTRACT_LOCAL_CLASSES  = YES
48EXTRACT_LOCAL_METHODS  = NO
49HIDE_UNDOC_MEMBERS     = NO
50HIDE_UNDOC_CLASSES     = NO
51HIDE_FRIEND_COMPOUNDS  = NO
52HIDE_IN_BODY_DOCS      = NO
53INTERNAL_DOCS          = NO
54CASE_SENSE_NAMES       = YES
55HIDE_SCOPE_NAMES       = NO
56SHOW_INCLUDE_FILES     = YES
57INLINE_INFO            = NO
58SORT_MEMBER_DOCS       = YES
59SORT_BRIEF_DOCS        = NO
60SORT_BY_SCOPE_NAME     = NO
61GENERATE_TODOLIST      = YES
62GENERATE_TESTLIST      = YES
63GENERATE_BUGLIST       = YES
64GENERATE_DEPRECATEDLIST= YES
65ENABLED_SECTIONS       =
66MAX_INITIALIZER_LINES  = 30
67SHOW_USED_FILES        = YES
68SHOW_DIRECTORIES       = YES
69FILE_VERSION_FILTER    =
70#---------------------------------------------------------------------------
71# configuration options related to warning and progress messages
72#---------------------------------------------------------------------------
73QUIET                  = NO
74WARNINGS               = YES
75WARN_IF_UNDOCUMENTED   = YES
76WARN_IF_DOC_ERROR      = YES
77WARN_NO_PARAMDOC       = NO
78WARN_FORMAT            = "$file:$line: $text"
79WARN_LOGFILE           = doxygen_warnings.log
80#---------------------------------------------------------------------------
81# configuration options related to the input files
82#---------------------------------------------------------------------------
83INPUT                  = ../../OgreMain \
84                         ../../PlatformManagers \
85                         ../../PlugIns \
86                         ../../RenderSystems \
87                         ../../ReferenceApplication/ReferenceAppLayer \
88                         apimainpage.txt
89FILE_PATTERNS          = Ogre*.h
90RECURSIVE              = YES
91EXCLUDE                =
92EXCLUDE_SYMLINKS       = NO
93EXCLUDE_PATTERNS       =
94EXAMPLE_PATH           =
95EXAMPLE_PATTERNS       =
96EXAMPLE_RECURSIVE      = NO
97IMAGE_PATH             =
98INPUT_FILTER           =
99FILTER_PATTERNS        =
100FILTER_SOURCE_FILES    = NO
101#---------------------------------------------------------------------------
102# configuration options related to source browsing
103#---------------------------------------------------------------------------
104SOURCE_BROWSER         = YES
105INLINE_SOURCES         = NO
106STRIP_CODE_COMMENTS    = YES
107REFERENCED_BY_RELATION = YES
108REFERENCES_RELATION    = YES
109VERBATIM_HEADERS       = YES
110#---------------------------------------------------------------------------
111# configuration options related to the alphabetical class index
112#---------------------------------------------------------------------------
113ALPHABETICAL_INDEX     = YES
114COLS_IN_ALPHA_INDEX    = 3
115IGNORE_PREFIX          =
116#---------------------------------------------------------------------------
117# configuration options related to the HTML output
118#---------------------------------------------------------------------------
119GENERATE_HTML          = YES
120HTML_OUTPUT            = html
121HTML_FILE_EXTENSION    = .html
122HTML_HEADER            = header.html
123HTML_FOOTER            = footer.html
124HTML_STYLESHEET        = style.css
125HTML_ALIGN_MEMBERS     = YES
126GENERATE_HTMLHELP      = YES
127CHM_FILE               = OgreAPIReference.chm
128HHC_LOCATION           =
129GENERATE_CHI           = NO
130BINARY_TOC             = NO
131TOC_EXPAND             = YES
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             = a4
145EXTRA_PACKAGES         =
146LATEX_HEADER           =
147PDF_HYPERLINKS         = YES
148USE_PDFLATEX           = YES
149LATEX_BATCHMODE        = YES
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_SCHEMA             =
173XML_DTD                =
174XML_PROGRAMLISTING     = YES
175#---------------------------------------------------------------------------
176# configuration options for the AutoGen Definitions output
177#---------------------------------------------------------------------------
178GENERATE_AUTOGEN_DEF   = NO
179#---------------------------------------------------------------------------
180# configuration options related to the Perl module output
181#---------------------------------------------------------------------------
182GENERATE_PERLMOD       = NO
183PERLMOD_LATEX          = NO
184PERLMOD_PRETTY         = YES
185PERLMOD_MAKEVAR_PREFIX =
186#---------------------------------------------------------------------------
187# Configuration options related to the preprocessor   
188#---------------------------------------------------------------------------
189ENABLE_PREPROCESSING   = YES
190MACRO_EXPANSION        = NO
191EXPAND_ONLY_PREDEF     = NO
192SEARCH_INCLUDES        = YES
193INCLUDE_PATH           =
194INCLUDE_FILE_PATTERNS  =
195PREDEFINED             =
196EXPAND_AS_DEFINED      =
197SKIP_FUNCTION_MACROS   = YES
198#---------------------------------------------------------------------------
199# Configuration::additions related to external references   
200#---------------------------------------------------------------------------
201TAGFILES               =
202GENERATE_TAGFILE       =
203ALLEXTERNALS           = NO
204EXTERNAL_GROUPS        = YES
205PERL_PATH              = /usr/bin/perl
206#---------------------------------------------------------------------------
207# Configuration options related to the dot tool   
208#---------------------------------------------------------------------------
209CLASS_DIAGRAMS         = YES
210HIDE_UNDOC_RELATIONS   = YES
211HAVE_DOT               = NO
212CLASS_GRAPH            = YES
213COLLABORATION_GRAPH    = NO
214GROUP_GRAPHS           = YES
215UML_LOOK               = NO
216TEMPLATE_RELATIONS     = NO
217INCLUDE_GRAPH          = NO
218INCLUDED_BY_GRAPH      = NO
219CALL_GRAPH             = NO
220GRAPHICAL_HIERARCHY    = YES
221DIRECTORY_GRAPH        = YES
222DOT_IMAGE_FORMAT       = png
223DOT_PATH               =
224DOTFILE_DIRS           =
225MAX_DOT_GRAPH_WIDTH    = 700
226MAX_DOT_GRAPH_HEIGHT   = 700
227MAX_DOT_GRAPH_DEPTH    = 1000
228DOT_TRANSPARENT        = NO
229DOT_MULTI_TARGETS      = NO
230GENERATE_LEGEND        = YES
231DOT_CLEANUP            = YES
232#---------------------------------------------------------------------------
233# Configuration::additions related to the search engine   
234#---------------------------------------------------------------------------
235SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.