From 01ae6992917be37cb93455a24b6789ea1d04d664 Mon Sep 17 00:00:00 2001 From: rbencina Date: Sun, 6 Sep 2015 12:37:38 +0000 Subject: [PATCH] checkfiledocs.py: only check source code under src and include --- doc/utils/checkfiledocs.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/utils/checkfiledocs.py b/doc/utils/checkfiledocs.py index b7a754e..663f5fe 100644 --- a/doc/utils/checkfiledocs.py +++ b/doc/utils/checkfiledocs.py @@ -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. ## ## The idea is to get a list of which files are missing doxygen documentation. - +## +## How to run: +## $ cd doc/utils +## $ python checkfiledocs.py # recurse from top and return a list of all with the given # extensions. ignore .svn directories. return absolute paths @@ -41,7 +44,8 @@ def doxygenHtmlDocFileName( sourceFile ): return sourceFile.replace( '_', '__' ).replace( '.', '_8' ) + '.html' -sourceFiles = recursiveFindFiles( paRootDirectory, [ '.c', '.h', '.cpp' ], True ); +sourceFiles = recursiveFindFiles( os.path.join(paRootDirectory,"src"), [ '.c', '.h', '.cpp' ], True ); +sourceFiles += recursiveFindFiles( os.path.join(paRootDirectory,"include"), [ '.c', '.h', '.cpp' ], True ); docFiles = recursiveFindFiles( paHtmlDocDirectory, [ '.html' ], False ); -- 2.43.0