source: trunk/VUT/doc/DummyModules/doxyfile_gtp_dummy @ 67

Revision 67, 9.5 KB checked in by bittner, 20 years ago (diff)

Documentation scripts for dummy modules added
  • Property svn:executable set to *
RevLine 
[67]1 Doxyfile 1.4.2
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = "GameTools Visibility Modules"
7PROJECT_NUMBER         = 0.1
8OUTPUT_DIRECTORY       = ./
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    = NO
26INLINE_INHERITED_MEMB  = NO
27FULL_PATH_NAMES        = NO
28STRIP_FROM_PATH        = ""
29STRIP_FROM_INC_PATH    =
30SHORT_NAMES            = NO
31JAVADOC_AUTOBRIEF      = NO
32MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP         = NO
34INHERIT_DOCS           = YES
35DISTRIBUTE_GROUP_DOC   = NO
36SEPARATE_MEMBER_PAGES  = NO
37TAB_SIZE               = 8
38ALIASES                =
39OPTIMIZE_OUTPUT_FOR_C  = NO
40OPTIMIZE_OUTPUT_JAVA   = NO
41SUBGROUPING            = YES
42#---------------------------------------------------------------------------
43# Build related configuration options
44#---------------------------------------------------------------------------
45EXTRACT_ALL            = YES
46EXTRACT_PRIVATE        = YES
47EXTRACT_STATIC         = YES
48EXTRACT_LOCAL_CLASSES  = YES
49EXTRACT_LOCAL_METHODS  = NO
50HIDE_UNDOC_MEMBERS     = NO
51HIDE_UNDOC_CLASSES     = YES
52HIDE_FRIEND_COMPOUNDS  = NO
53HIDE_IN_BODY_DOCS      = NO
54INTERNAL_DOCS          = NO
55CASE_SENSE_NAMES       = NO
56HIDE_SCOPE_NAMES       = NO
57SHOW_INCLUDE_FILES     = YES
58INLINE_INFO            = YES
59SORT_MEMBER_DOCS       = YES
60SORT_BRIEF_DOCS        = NO
61SORT_BY_SCOPE_NAME     = NO
62GENERATE_TODOLIST      = YES
63GENERATE_TESTLIST      = YES
64GENERATE_BUGLIST       = YES
65GENERATE_DEPRECATEDLIST= YES
66ENABLED_SECTIONS       =
67MAX_INITIALIZER_LINES  = 30
68SHOW_USED_FILES        = YES
69SHOW_DIRECTORIES       = NO
70FILE_VERSION_FILTER    =
71#---------------------------------------------------------------------------
72# configuration options related to warning and progress messages
73#---------------------------------------------------------------------------
74QUIET                  = NO
75WARNINGS               = YES
76WARN_IF_UNDOCUMENTED   = YES
77WARN_IF_DOC_ERROR      = YES
78WARN_NO_PARAMDOC       = NO
79WARN_FORMAT            = "$file:$line: $text"
80WARN_LOGFILE           =
81#---------------------------------------------------------------------------
82# configuration options related to the input files
83#---------------------------------------------------------------------------
84INPUT                  = ../../GtpVisibility/src/ \
85                         ../../GtpVisibility/include/ \
86                         ../../Ogre/src/ \
87                         ../../Ogre/include/ \
88                         ../../GtpVisibilityPreprocessor/src/ \
89                         ../../GtpVisibilityPreprocessor/include/
90
91FILE_PATTERNS          = *.c \
92                         *.cc \
93                         *.cxx \
94                         *.cpp \
95                         *.c++ \
96                         *.d \
97                         *.java \
98                         *.ii \
99                         *.ixx \
100                         *.ipp \
101                         *.i++ \
102                         *.inl \
103                         *.h \
104                         *.hh \
105                         *.hxx \
106                         *.hpp \
107                         *.h++ \
108                         *.idl \
109                         *.odl \
110                         *.cs \
111                         *.php \
112                         *.php3 \
113                         *.inc \
114                         *.m \
115                         *.mm \
116                         *.dox
117RECURSIVE              = YES
118EXCLUDE                =
119EXCLUDE_SYMLINKS       = NO
120EXCLUDE_PATTERNS       = */Test/*
121EXAMPLE_PATH           =
122EXAMPLE_PATTERNS       = *
123EXAMPLE_RECURSIVE      = NO
124IMAGE_PATH             =
125INPUT_FILTER           =
126FILTER_PATTERNS        =
127FILTER_SOURCE_FILES    = NO
128#---------------------------------------------------------------------------
129# configuration options related to source browsing
130#---------------------------------------------------------------------------
131SOURCE_BROWSER         = YES
132INLINE_SOURCES         = NO
133STRIP_CODE_COMMENTS    = YES
134REFERENCED_BY_RELATION = YES
135REFERENCES_RELATION    = YES
136VERBATIM_HEADERS       = YES
137#---------------------------------------------------------------------------
138# configuration options related to the alphabetical class index
139#---------------------------------------------------------------------------
140ALPHABETICAL_INDEX     = YES
141COLS_IN_ALPHA_INDEX    = 5
142IGNORE_PREFIX          =
143#---------------------------------------------------------------------------
144# configuration options related to the HTML output
145#---------------------------------------------------------------------------
146GENERATE_HTML          = NO
147HTML_OUTPUT            = html
148HTML_FILE_EXTENSION    = .html
149HTML_HEADER            =
150HTML_FOOTER            =
151HTML_STYLESHEET        =
152HTML_ALIGN_MEMBERS     = YES
153GENERATE_HTMLHELP      = NO
154CHM_FILE               =
155HHC_LOCATION           =
156GENERATE_CHI           = NO
157BINARY_TOC             = NO
158TOC_EXPAND             = NO
159DISABLE_INDEX          = NO
160ENUM_VALUES_PER_LINE   = 4
161GENERATE_TREEVIEW      = YES
162TREEVIEW_WIDTH         = 250
163#---------------------------------------------------------------------------
164# configuration options related to the LaTeX output
165#---------------------------------------------------------------------------
166GENERATE_LATEX         = YES
167LATEX_OUTPUT           = latex
168LATEX_CMD_NAME         = latex
169MAKEINDEX_CMD_NAME     = makeindex
170COMPACT_LATEX          = NO
171PAPER_TYPE             = a4wide
172EXTRA_PACKAGES         =
173LATEX_HEADER           = header.tex
174PDF_HYPERLINKS         = YES
175USE_PDFLATEX           = YES
176LATEX_BATCHMODE        = NO
177LATEX_HIDE_INDICES     = NO
178#---------------------------------------------------------------------------
179# configuration options related to the RTF output
180#---------------------------------------------------------------------------
181GENERATE_RTF           = NO
182RTF_OUTPUT             = rtf
183COMPACT_RTF            = NO
184RTF_HYPERLINKS         = NO
185RTF_STYLESHEET_FILE    =
186RTF_EXTENSIONS_FILE    =
187#---------------------------------------------------------------------------
188# configuration options related to the man page output
189#---------------------------------------------------------------------------
190GENERATE_MAN           = NO
191MAN_OUTPUT             = man
192MAN_EXTENSION          = .3
193MAN_LINKS              = NO
194#---------------------------------------------------------------------------
195# configuration options related to the XML output
196#---------------------------------------------------------------------------
197GENERATE_XML           = NO
198XML_OUTPUT             = xml
199XML_SCHEMA             =
200XML_DTD                =
201XML_PROGRAMLISTING     = YES
202#---------------------------------------------------------------------------
203# configuration options for the AutoGen Definitions output
204#---------------------------------------------------------------------------
205GENERATE_AUTOGEN_DEF   = NO
206#---------------------------------------------------------------------------
207# configuration options related to the Perl module output
208#---------------------------------------------------------------------------
209GENERATE_PERLMOD       = NO
210PERLMOD_LATEX          = NO
211PERLMOD_PRETTY         = YES
212PERLMOD_MAKEVAR_PREFIX =
213#---------------------------------------------------------------------------
214# Configuration options related to the preprocessor   
215#---------------------------------------------------------------------------
216ENABLE_PREPROCESSING   = YES
217MACRO_EXPANSION        = NO
218EXPAND_ONLY_PREDEF     = NO
219SEARCH_INCLUDES        = YES
220INCLUDE_PATH           =
221INCLUDE_FILE_PATTERNS  =
222PREDEFINED             =
223EXPAND_AS_DEFINED      =
224SKIP_FUNCTION_MACROS   = YES
225#---------------------------------------------------------------------------
226# Configuration::additions related to external references   
227#---------------------------------------------------------------------------
228TAGFILES               =
229GENERATE_TAGFILE       =
230ALLEXTERNALS           = NO
231EXTERNAL_GROUPS        = YES
232PERL_PATH              = /usr/bin/perl
233#---------------------------------------------------------------------------
234# Configuration options related to the dot tool   
235#---------------------------------------------------------------------------
236CLASS_DIAGRAMS         = YES
237HIDE_UNDOC_RELATIONS   = YES
238HAVE_DOT               = YES
239CLASS_GRAPH            = YES
240COLLABORATION_GRAPH    = NO
241GROUP_GRAPHS           = YES
242UML_LOOK               = YES
243TEMPLATE_RELATIONS     = NO
244INCLUDE_GRAPH          = YES
245INCLUDED_BY_GRAPH      = YES
246CALL_GRAPH             = YES
247GRAPHICAL_HIERARCHY    = YES
248DIRECTORY_GRAPH        = YES
249DOT_IMAGE_FORMAT       = png
250DOT_PATH               =
251DOTFILE_DIRS           =
252MAX_DOT_GRAPH_WIDTH    = 1024
253MAX_DOT_GRAPH_HEIGHT   = 1024
254MAX_DOT_GRAPH_DEPTH    = 1000
255DOT_TRANSPARENT        = NO
256DOT_MULTI_TARGETS      = NO
257GENERATE_LEGEND        = YES
258DOT_CLEANUP            = YES
259#---------------------------------------------------------------------------
260# Configuration::additions related to the search engine   
261#---------------------------------------------------------------------------
262SEARCHENGINE           = NO
Note: See TracBrowser for help on using the repository browser.