Filter excluded/non-documented classes from doxydoc (only for pyfaust).

gen_doc/CMakeLists.txt

@@ -15,6 +15,8 @@ if(BUILD_DOCUMENTATION)
 		configure_file(${FAUST_DOC_SRC_DIR}/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile @ONLY)
 		# ./gen_doc/images/* files is duplicated in doc/html/ to call images documentation in the source code with relative path of image's files, from build directory.
 		configure_file(${FAUST_DOC_SRC_DIR}/py_filterout_namespace.py ${PROJECT_BINARY_DIR}/doc/py_filterout_namespace.py @ONLY)
+        configure_file(${FAUST_DOC_SRC_DIR}/filterout_excluded_classes.py
+            ${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py @ONLY)
 		if(UNIX)
 			configure_file(${FAUST_DOC_SRC_DIR}/py_filter.sh.in ${PROJECT_BINARY_DIR}/doc/py_filter @ONLY)
 			configure_file(${FAUST_DOC_SRC_DIR}/doxymatlab/m2cpp.pl ${PROJECT_BINARY_DIR}/doc/m2cpp @ONLY)

gen_doc/Doxyfile.in

@@ -519,7 +519,7 @@ EXCLUDE_SYMLINKS       = NO
 
 EXCLUDE_PATTERNS       = *faust_MatDense_gpu.h *faust_MatSparse_gpu.h 
 
-EXCLUDE_SYMBOLS = mtimes_trans subsasgn get_factor_nonopt reshape ABC ParamsPalm4MSAFGFT UpdateCholesky UpdateCholeskyFull UpdateCholeskySparse greed_omp_chol hierarchical_constends palm4msa_constends
+EXCLUDE_SYMBOLS = mtimes_trans subsasgn get_factor_nonopt reshape ABC ParamsPalm4MSAFGFT UpdateCholesky UpdateCholeskyFull UpdateCholeskySparse greed_omp_chol hierarchical_constends palm4msa_constends ConstraintGeneric ConstraintMat ConstraintReal ConstraintName ConstraintInt
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 

gen_doc/filterout_excluded_classes.py

+import sys
+import re
+
+"""
+This script intends to filter out the doxygen non-documented classes (set in EXCLUDE_SYMBOLS)
+"""
+
+# example to filter
+# <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><b>ConstraintReal</b></td></tr>                                                 
+# <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class represents a real constraint on a matrix. <br /></td></tr>                                                                
+# <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+
+# example to keep
+# <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmatfaust_1_1factparams_1_1ParamsFact.html">ParamsFact</a></td></tr>
+# <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The parent abstract class to represent the general factorization parameters.  <a href="classmatfaust_1_1factparams_1_1ParamsFact.html#details">More...</a><br /></td></tr>
+# <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+
+
+in_block_to_del=False
+count_in_block_lines = 0
+for line in sys.stdin:
+    if(in_block_to_del):
+        count_in_block_lines -= 1
+        if(count_in_block_lines <= 0):
+            in_block_to_del = False
+    elif(re.match('.*class &#160.*"bottom"><b>', line)):
+        in_block_to_del=True
+        count_in_block_lines = 2
+    else:
+        print(line, end='')

gen_doc/py_filter.bat.in

-@PYTHON3_EXE@ -m doxypypy.doxypypy -a -c %1 %2 %3 |  @PYTHON3_EXE@ py_filterout_namespace.py pyfaust.__init__. pyfaust.factparams. pyfaust.demo.
+@PYTHON3_EXE@ -m doxypypy.doxypypy -a -c %1 %2 %3 |  @PYTHON3_EXE@ py_filterout_namespace.py pyfaust.__init__. pyfaust.factparams. pyfaust.demo. | @PYTHON3_EXE@ filterout_excluded_classes.py
 

gen_doc/py_filter.sh.in

@@ -3,6 +3,8 @@
 
 @PYTHON3_EXE@ -m doxypypy.doxypypy -a -c $* | @PYTHON3_EXE@ \
 py_filterout_namespace.py pyfaust.__init__. pyfaust.factparams. pyfaust.demo. \
-pyfaust.tools. pyfaust.fact.
+pyfaust.tools. pyfaust.fact. \
+pyfaust.factparams.ConstraintMat | @PYTHON3_EXE@ \
+filterout_excluded_classes.py