initial commit

tools/tracker/packages/portaudio/doc/src/license.dox

@@ -0,0 +1,38 @@
+/** @page License PortAudio License
+
+PortAudio Portable Real-Time Audio Library <br>
+Copyright (c) 1999-2006 Ross Bencina, Phil Burk
+
+
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+<br>
+
+The text above constitutes the entire PortAudio license; however, 
+the PortAudio community also makes the following non-binding requests:
+
+Any person wishing to distribute modifications to the Software is
+requested to send the modifications to the original developer so that
+they can be incorporated into the canonical version. It is also 
+requested that these non-binding requests be included along with the 
+license above.
+
+*/

tools/tracker/packages/portaudio/doc/src/mainpage.dox

@@ -0,0 +1,44 @@
+/* doxygen index page */
+/** @mainpage
+
+PortAudio is an open-source cross-platform <20>C<EFBFBD> library for audio input
+and output. It is designed to simplify the porting of audio applications
+between various platforms, and also to simplify the development of audio
+software in general by hiding the complexities of device interfacing.
+
+See the PortAudio website for further information http://www.portaudio.com
+
+This documentation pertains to PortAudio V19, API version 2.0 which is
+currently under development. API version 2.0 differs in a number of ways from
+previous versions, please consult the enhancement proposals for further details:
+http://www.portaudio.com/docs/proposals/index.html
+
+This documentation is under construction. Things you might be interested in
+include:
+
+- The PortAudio API 2.0, as documented in portaudio.h
+
+- Tutorials for the V19 API, currently housed on the PortAudio Wiki:
+http://www.portaudio.com/trac/wiki/TutorialDir/TutorialStart
+
+- Implementation status is documented here:
+http://www.portaudio.com/docs/proposals/status.html
+
+- @ref srcguide
+
+- The @ref License
+
+
+If you're interested in contributing to PortAudio, you may be interested in:
+
+- The doxygen generated <a href="todo.html">TODO List</a>. Feel free to pick an item off TODO list 
+and fix/implement it. You may want to enquire about status on the PortAudio mailing list first.
+
+- Our issue tracking system:
+http://www.portaudio.com/trac
+
+- Coding guidelines:
+http://www.portaudio.com/docs/proposals/014-StyleGuide.html
+
+
+*/

tools/tracker/packages/portaudio/doc/src/srcguide.dox

@@ -0,0 +1,38 @@
+/*
+ define all of the file groups used to structure the documentation.
+*/
+
+/**
+ @defgroup common_src Source code common to all implementations
+*/
+
+/**
+ @defgroup win_src Source code common to all Windows implementations
+*/
+
+/**
+ @defgroup unix_src Source code common to all Unix implementations
+*/
+
+/**
+ @defgroup macosx_src Source code common to all Macintosh implementations
+*/
+
+/**
+ @defgroup hostaip_src Source code for specific Host APIs
+*/
+
+/**
+ @defgroup test_src Test and example programs
+*/
+
+/**
+ @page srcguide A guide to the PortAudio sources.
+
+ - \ref common_src
+ - \ref win_src
+ - \ref unix_src
+ - \ref macosx_src
+ - \ref hostaip_src
+ - \ref test_src
+*/

tools/tracker/packages/portaudio/doc/utils/checkfiledocs.py

@@ -0,0 +1,76 @@
+import os
+import os.path
+import string
+
+paRootDirectory = '../../'
+paHtmlDocDirectory = os.path.join( paRootDirectory, "doc", "html" )
+
+##this script assumes that html doxygen documentation has been generated
+##
+##it then walks the entire portaudio source tree and check that
+##- every source file (.c,.h,.cpp) has a doxygen comment block containing
+##	- a @file directive
+##	- a @brief directive
+##	- a @ingroup directive
+##- it also checks that a corresponding html documentation file has been generated.
+##
+##This can be used as a first-level check to make sure the documentation is in order.
+##
+##The idea is to get a list of which files are missing doxygen documentation.
+
+
+# recurse from top and return a list of all with the given
+# extensions. ignore .svn directories. return absolute paths
+def recursiveFindFiles( top, extensions, includePaths ):
+    result = []
+    for (dirpath, dirnames, filenames) in os.walk(top):
+        if not '.svn' in dirpath:
+            for f in filenames:
+                if os.path.splitext(f)[1] in extensions:
+                    if includePaths:
+                        result.append( os.path.abspath( os.path.join( dirpath, f ) ) )
+                    else:
+                        result.append( f )
+    return result
+
+# generate the html file name that doxygen would use for
+# a particular source file. this is a brittle conversion
+# which i worked out by trial and error
+def doxygenHtmlDocFileName( sourceFile ):
+    return sourceFile.replace( '_', '__' ).replace( '.', '_8' ) + '.html'
+
+
+sourceFiles = recursiveFindFiles( paRootDirectory, [ '.c', '.h', '.cpp' ], True );
+docFiles = recursiveFindFiles( paHtmlDocDirectory, [ '.html' ], False );
+
+
+
+currentFile = ""
+
+def printError( f, message ):
+    global currentFile
+    if f != currentFile:
+        currentFile = f
+        print f, ":"
+    print "\t!", message
+
+
+for f in sourceFiles:
+    if not doxygenHtmlDocFileName( os.path.basename(f) ) in docFiles:
+        printError( f, "no doxygen generated doc page" )
+
+    s = file( f, 'rt' ).read()
+
+    if not '/**' in s:
+        printError( f, "no doxygen /** block" )  
+    
+    if not '@file' in s:
+        printError( f, "no doxygen @file tag" )
+
+    if not '@brief' in s:
+        printError( f, "no doxygen @brief tag" )
+        
+    if not '@ingroup' in s:
+        printError( f, "no doxygen @ingroup tag" )
+        
+