added Doxyfile.developer for generating internal docs. added doxygen brief descriptio...

diff --git a/Doxyfile b/Doxyfile
index ac2eb151acdca2304c90ffd1fae61b549ac93b4c..33b9aae67cd71f3b23df442f469f17ff6b2ce505 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -43,7 +43,7 @@ SUBGROUPING            = YES
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
-EXTRACT_ALL            = YES
+EXTRACT_ALL            = NO
 EXTRACT_PRIVATE        = NO
 EXTRACT_STATIC         = NO
 EXTRACT_LOCAL_CLASSES  = YES
@@ -60,9 +60,9 @@ INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
 SORT_BRIEF_DOCS        = NO
 SORT_BY_SCOPE_NAME     = NO
-GENERATE_TODOLIST      = YES
-GENERATE_TESTLIST      = YES
-GENERATE_BUGLIST       = YES
+GENERATE_TODOLIST      = NO
+GENERATE_TESTLIST      = NO
+GENERATE_BUGLIST       = NO
 GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       = 
 MAX_INITIALIZER_LINES  = 30
@@ -84,10 +84,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 INPUT                  = doc/src \
                          include \
-                         examples #\          
-#                         src \
-#                         test \
-#                         qa
+                         examples
 FILE_PATTERNS          = *.h \
                          *.c \
                          *.cpp \

diff --git a/Doxyfile.developer b/Doxyfile.developer
new file mode 100644 (file)
index 0000000..f018ed3
--- /dev/null
+++ b/Doxyfile.developer
@@ -0,0 +1,241 @@
+# Doxyfile 1.4.6\r
+\r
+#---------------------------------------------------------------------------\r
+# Project related configuration options\r
+#---------------------------------------------------------------------------\r
+PROJECT_NAME           = PortAudio\r
+PROJECT_NUMBER         = 2.0\r
+OUTPUT_DIRECTORY       = ./doc/\r
+CREATE_SUBDIRS         = NO\r
+OUTPUT_LANGUAGE        = English\r
+USE_WINDOWS_ENCODING   = NO\r
+BRIEF_MEMBER_DESC      = YES\r
+REPEAT_BRIEF           = YES\r
+ABBREVIATE_BRIEF       = "The $name class" \\r
+                         "The $name widget" \\r
+                         "The $name file" \\r
+                         is \\r
+                         provides \\r
+                         specifies \\r
+                         contains \\r
+                         represents \\r
+                         a \\r
+                         an \\r
+                         the\r
+ALWAYS_DETAILED_SEC    = NO\r
+INLINE_INHERITED_MEMB  = NO\r
+FULL_PATH_NAMES        = NO\r
+STRIP_FROM_PATH        = \r
+STRIP_FROM_INC_PATH    = \r
+SHORT_NAMES            = NO\r
+JAVADOC_AUTOBRIEF      = NO\r
+MULTILINE_CPP_IS_BRIEF = NO\r
+DETAILS_AT_TOP         = NO\r
+INHERIT_DOCS           = YES\r
+SEPARATE_MEMBER_PAGES  = NO\r
+TAB_SIZE               = 8\r
+ALIASES                = \r
+OPTIMIZE_OUTPUT_FOR_C  = YES\r
+OPTIMIZE_OUTPUT_JAVA   = NO\r
+BUILTIN_STL_SUPPORT    = NO\r
+DISTRIBUTE_GROUP_DOC   = NO\r
+SUBGROUPING            = YES\r
+#---------------------------------------------------------------------------\r
+# Build related configuration options\r
+#---------------------------------------------------------------------------\r
+EXTRACT_ALL            = YES\r
+EXTRACT_PRIVATE        = NO\r
+EXTRACT_STATIC         = NO\r
+EXTRACT_LOCAL_CLASSES  = YES\r
+EXTRACT_LOCAL_METHODS  = NO\r
+HIDE_UNDOC_MEMBERS     = NO\r
+HIDE_UNDOC_CLASSES     = NO\r
+HIDE_FRIEND_COMPOUNDS  = NO\r
+HIDE_IN_BODY_DOCS      = NO\r
+INTERNAL_DOCS          = YES\r
+CASE_SENSE_NAMES       = YES\r
+HIDE_SCOPE_NAMES       = NO\r
+SHOW_INCLUDE_FILES     = YES\r
+INLINE_INFO            = YES\r
+SORT_MEMBER_DOCS       = YES\r
+SORT_BRIEF_DOCS        = NO\r
+SORT_BY_SCOPE_NAME     = NO\r
+GENERATE_TODOLIST      = YES\r
+GENERATE_TESTLIST      = YES\r
+GENERATE_BUGLIST       = YES\r
+GENERATE_DEPRECATEDLIST= YES\r
+ENABLED_SECTIONS       = INTERNAL\r
+MAX_INITIALIZER_LINES  = 30\r
+SHOW_USED_FILES        = YES\r
+SHOW_DIRECTORIES       = YES\r
+FILE_VERSION_FILTER    = \r
+#---------------------------------------------------------------------------\r
+# configuration options related to warning and progress messages\r
+#---------------------------------------------------------------------------\r
+QUIET                  = NO\r
+WARNINGS               = YES\r
+WARN_IF_UNDOCUMENTED   = YES\r
+WARN_IF_DOC_ERROR      = YES\r
+WARN_NO_PARAMDOC       = NO\r
+WARN_FORMAT            = "$file:$line: $text"\r
+WARN_LOGFILE           = \r
+#---------------------------------------------------------------------------\r
+# configuration options related to the input files\r
+#---------------------------------------------------------------------------\r
+INPUT                  = doc/src \\r
+                         include \\r
+                         examples \          \r
+                         src \\r
+                         test \\r
+                         qa\r
+FILE_PATTERNS          = *.h \\r
+                         *.c \\r
+                         *.cpp \\r
+                         *.dox\r
+RECURSIVE              = YES\r
+EXCLUDE                = src/hostapi/wasapi/mingw-include\r
+EXCLUDE_SYMLINKS       = NO\r
+EXCLUDE_PATTERNS       = \r
+EXAMPLE_PATH           = \r
+EXAMPLE_PATTERNS       = \r
+EXAMPLE_RECURSIVE      = NO\r
+IMAGE_PATH             = doc/src/images\r
+INPUT_FILTER           = \r
+FILTER_PATTERNS        = \r
+FILTER_SOURCE_FILES    = NO\r
+#---------------------------------------------------------------------------\r
+# configuration options related to source browsing\r
+#---------------------------------------------------------------------------\r
+SOURCE_BROWSER         = NO\r
+INLINE_SOURCES         = NO\r
+STRIP_CODE_COMMENTS    = YES\r
+REFERENCED_BY_RELATION = YES\r
+REFERENCES_RELATION    = YES\r
+USE_HTAGS              = NO\r
+VERBATIM_HEADERS       = YES\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the alphabetical class index\r
+#---------------------------------------------------------------------------\r
+ALPHABETICAL_INDEX     = NO\r
+COLS_IN_ALPHA_INDEX    = 5\r
+IGNORE_PREFIX          = \r
+#---------------------------------------------------------------------------\r
+# configuration options related to the HTML output\r
+#---------------------------------------------------------------------------\r
+GENERATE_HTML          = YES\r
+HTML_OUTPUT            = html\r
+HTML_FILE_EXTENSION    = .html\r
+HTML_HEADER            = \r
+HTML_FOOTER            = \r
+HTML_STYLESHEET        = \r
+HTML_ALIGN_MEMBERS     = YES\r
+GENERATE_HTMLHELP      = NO\r
+CHM_FILE               = \r
+HHC_LOCATION           = \r
+GENERATE_CHI           = NO\r
+BINARY_TOC             = NO\r
+TOC_EXPAND             = NO\r
+DISABLE_INDEX          = NO\r
+ENUM_VALUES_PER_LINE   = 4\r
+GENERATE_TREEVIEW      = NO\r
+TREEVIEW_WIDTH         = 250\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the LaTeX output\r
+#---------------------------------------------------------------------------\r
+GENERATE_LATEX         = NO\r
+LATEX_OUTPUT           = latex\r
+LATEX_CMD_NAME         = latex\r
+MAKEINDEX_CMD_NAME     = makeindex\r
+COMPACT_LATEX          = NO\r
+PAPER_TYPE             = a4wide\r
+EXTRA_PACKAGES         = \r
+LATEX_HEADER           = \r
+PDF_HYPERLINKS         = NO\r
+USE_PDFLATEX           = NO\r
+LATEX_BATCHMODE        = NO\r
+LATEX_HIDE_INDICES     = NO\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the RTF output\r
+#---------------------------------------------------------------------------\r
+GENERATE_RTF           = NO\r
+RTF_OUTPUT             = rtf\r
+COMPACT_RTF            = NO\r
+RTF_HYPERLINKS         = NO\r
+RTF_STYLESHEET_FILE    = \r
+RTF_EXTENSIONS_FILE    = \r
+#---------------------------------------------------------------------------\r
+# configuration options related to the man page output\r
+#---------------------------------------------------------------------------\r
+GENERATE_MAN           = NO\r
+MAN_OUTPUT             = man\r
+MAN_EXTENSION          = .3\r
+MAN_LINKS              = NO\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the XML output\r
+#---------------------------------------------------------------------------\r
+GENERATE_XML           = NO\r
+XML_OUTPUT             = xml\r
+XML_SCHEMA             = \r
+XML_DTD                = \r
+XML_PROGRAMLISTING     = YES\r
+#---------------------------------------------------------------------------\r
+# configuration options for the AutoGen Definitions output\r
+#---------------------------------------------------------------------------\r
+GENERATE_AUTOGEN_DEF   = NO\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the Perl module output\r
+#---------------------------------------------------------------------------\r
+GENERATE_PERLMOD       = NO\r
+PERLMOD_LATEX          = NO\r
+PERLMOD_PRETTY         = YES\r
+PERLMOD_MAKEVAR_PREFIX = \r
+#---------------------------------------------------------------------------\r
+# Configuration options related to the preprocessor   \r
+#---------------------------------------------------------------------------\r
+ENABLE_PREPROCESSING   = YES\r
+MACRO_EXPANSION        = NO\r
+EXPAND_ONLY_PREDEF     = NO\r
+SEARCH_INCLUDES        = YES\r
+INCLUDE_PATH           = \r
+INCLUDE_FILE_PATTERNS  = \r
+PREDEFINED             = \r
+EXPAND_AS_DEFINED      = \r
+SKIP_FUNCTION_MACROS   = YES\r
+#---------------------------------------------------------------------------\r
+# Configuration::additions related to external references   \r
+#---------------------------------------------------------------------------\r
+TAGFILES               = \r
+GENERATE_TAGFILE       = \r
+ALLEXTERNALS           = NO\r
+EXTERNAL_GROUPS        = YES\r
+PERL_PATH              = /usr/bin/perl\r
+#---------------------------------------------------------------------------\r
+# Configuration options related to the dot tool   \r
+#---------------------------------------------------------------------------\r
+CLASS_DIAGRAMS         = NO\r
+HIDE_UNDOC_RELATIONS   = NO\r
+HAVE_DOT               = NO\r
+CLASS_GRAPH            = YES\r
+COLLABORATION_GRAPH    = YES\r
+GROUP_GRAPHS           = YES\r
+UML_LOOK               = NO\r
+TEMPLATE_RELATIONS     = YES\r
+INCLUDE_GRAPH          = YES\r
+INCLUDED_BY_GRAPH      = YES\r
+CALL_GRAPH             = NO\r
+GRAPHICAL_HIERARCHY    = YES\r
+DIRECTORY_GRAPH        = YES\r
+DOT_IMAGE_FORMAT       = png\r
+DOT_PATH               = \r
+DOTFILE_DIRS           = \r
+MAX_DOT_GRAPH_WIDTH    = 1024\r
+MAX_DOT_GRAPH_HEIGHT   = 1024\r
+MAX_DOT_GRAPH_DEPTH    = 1000\r
+DOT_TRANSPARENT        = NO\r
+DOT_MULTI_TARGETS      = NO\r
+GENERATE_LEGEND        = YES\r
+DOT_CLEANUP            = YES\r
+#---------------------------------------------------------------------------\r
+# Configuration::additions related to the search engine   \r
+#---------------------------------------------------------------------------\r
+SEARCHENGINE           = NO\r

diff --git a/doc/src/mainpage.dox b/doc/src/mainpage.dox
index c1b2b3578f54ec0b26f880b10ce7e9e8ab90a6c5..3b3cf8671466bfc220d6b053aa85f9f56ad5f509 100644 (file)
--- a/doc/src/mainpage.dox
+++ b/doc/src/mainpage.dox
@@ -11,7 +11,7 @@ PortAudio is a cross-platform, open-source C language library for real-time audi
 - @ref api_overview<br>\r
 A top-down view of the PortAudio API, its capabilities, functions and data structures\r
 \r
-- <a href="http://www.portaudio.com/trac/wiki/TutorialDir/TutorialStart">PortAudio tutorials</a><br>\r
+- <a href="http://www.portaudio.com/trac/wiki/TutorialDir/TutorialStart">PortAudio Tutorials</a><br>\r
 Get started writing code with PortAudio tutorials\r
 \r
 - @ref examples_src "Examples"<br>\r
@@ -26,7 +26,7 @@ PortAudio is licenced under the MIT Expat open source licence. We make a non-bin
 - portaudio.h Portable API<br>\r
 Detailed documentation for each portable API function and data type\r
 \r
-- @ref public_header "Host API specific extensions"<br>\r
+- @ref public_header "Host API Specific Extensions"<br>\r
 Documentation for non-portable platform-specific host API extensions\r
 \r
 \r
@@ -39,11 +39,11 @@ Documentation for non-portable platform-specific host API extensions
 - <a href="http://www.portaudio.com/trac">The PortAudio wiki</a>\r
 \r
 \r
-@section developer_resources Developer resources\r
+@section developer_resources Developer Resources\r
 \r
-\if INTERNAL\r
-- @ref srcguide \r
-\endif\r
+@if INTERNAL\r
+- @ref srcguide\r
+@endif\r
 \r
 - <a href="http://www.portaudio.com/trac">Our Trac wiki and issue tracking system</a>\r
 \r
@@ -52,7 +52,7 @@ Documentation for non-portable platform-specific host API extensions
 If you're interested in helping out with PortAudio development we're more than happy for you to be involved. Just drop by the PortAudio mailing list and ask how you can help. Or <a href="http://www.portaudio.com/trac/report/3">check out the starter tickets in Trac</a>.\r
 \r
 \r
-@section older_api_versions Older API versions\r
+@section older_api_versions Older API Versions\r
 \r
 This documentation covers the current API version: PortAudio V19, API version 2.0. API 2.0 differs in a number of ways from previous versions (most often encountered in PortAudio V18), please consult the enhancement proposals for details of what was added/changed for V19:\r
 http://www.portaudio.com/docs/proposals/index.html\r

diff --git a/doc/src/srcguide.dox b/doc/src/srcguide.dox
index aabff5813cbffbc720a45ad20596d8e80a2f0925..c13babfdac48c10bee71cf64ae87538b1f556f20 100644 (file)
--- a/doc/src/srcguide.dox
+++ b/doc/src/srcguide.dox
@@ -42,10 +42,10 @@
 \r
 /**\r
  @internal\r
- @page srcguide A guide to the PortAudio sources.\r
+ @page srcguide A guide to the PortAudio sources\r
 \r
  - \ref public_header\r
- - \ref example_src\r
+ - \ref examples_src\r
  - \ref common_src\r
  - \ref win_src\r
  - \ref unix_src\r

diff --git a/examples/paex_wmme_ac3.c b/examples/paex_wmme_ac3.c
index edca204da1560b3cb9206829a017044f8ac2fd9e..e7b4554ab7af49836926c607da288c78a54f1533 100644 (file)
--- a/examples/paex_wmme_ac3.c
+++ b/examples/paex_wmme_ac3.c
@@ -1,3 +1,8 @@
+/** @file paex_wmme_ac3.c\r
+       @ingroup examples_src\r
+       @brief Use WMME-specific interface to send raw AC3 data to a S/PDIF output.\r
+       @author Ross Bencina <rossb@audiomulch.com>\r
+*/\r
 /*\r
  * $Id: $\r
  * Portable Audio I/O Library\r

diff --git a/examples/paex_wmme_surround.c b/examples/paex_wmme_surround.c
index bed94ea1683c476c97cbc9adbb7f85f70c5addff..9940101f995bac8af666043f35442c9300486699 100644 (file)
--- a/examples/paex_wmme_surround.c
+++ b/examples/paex_wmme_surround.c
@@ -1,3 +1,8 @@
+/** @file paex_wmme_surround.c\r
+       @ingroup examples_src\r
+       @brief Use WMME-specific channelMask to request 5.1 surround sound output.\r
+       @author Ross Bencina <rossb@audiomulch.com>\r
+*/\r
 /*\r
  * $Id: $\r
  * Portable Audio I/O Library\r