]> Repos - portaudio/commitdiff
checkfiledocs.py: only check source code under src and include
authorrbencina <rbencina@0f58301d-fd10-0410-b4af-bbb618454e57>
Sun, 6 Sep 2015 12:37:38 +0000 (12:37 +0000)
committerrbencina <rbencina@0f58301d-fd10-0410-b4af-bbb618454e57>
Sun, 6 Sep 2015 12:37:38 +0000 (12:37 +0000)
doc/utils/checkfiledocs.py

index b7a754e23db1b6c30f80bfc19f0603fdda2f9837..663f5fe873deb77c1260d0f06cbf2e62e770fbde 100644 (file)
@@ -18,7 +18,10 @@ paHtmlDocDirectory = os.path.join( paRootDirectory, "doc", "html" )
 ## This can be used as a first-level check to make sure the documentation is in order.\r
 ##\r
 ## The idea is to get a list of which files are missing doxygen documentation.\r
-\r
+##\r
+## How to run:\r
+##  $ cd doc/utils\r
+##  $ python checkfiledocs.py\r
 \r
 # recurse from top and return a list of all with the given\r
 # extensions. ignore .svn directories. return absolute paths\r
@@ -41,7 +44,8 @@ def doxygenHtmlDocFileName( sourceFile ):
     return sourceFile.replace( '_', '__' ).replace( '.', '_8' ) + '.html'\r
 \r
 \r
-sourceFiles = recursiveFindFiles( paRootDirectory, [ '.c', '.h', '.cpp' ], True );\r
+sourceFiles = recursiveFindFiles( os.path.join(paRootDirectory,"src"), [ '.c', '.h', '.cpp' ], True );\r
+sourceFiles += recursiveFindFiles( os.path.join(paRootDirectory,"include"), [ '.c', '.h', '.cpp' ], True );\r
 docFiles = recursiveFindFiles( paHtmlDocDirectory, [ '.html' ], False );\r
 \r
 \r