root/trunk/Doxyfile

Revision 521, 8.7 KB (checked in by gbooker, 4 years ago)

Switch to xml for doxygen.

Useing Doxyclean ( http://mattballdesign.com/blog/tag/doxyclean/), it produces much nicer html, and should look better in the future

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