root/portaudio/trunk/Doxyfile

Revision 1084, 8.7 KB (checked in by rossb, 2 years ago)

doxygen updates: renamed config.doxy to Doxyfile, moved and updated doxygen mainpage content from pa_front.c to doc/src/mainpage.dox

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