Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 5a08ce43 authored by hhakim's avatar hhakim
Browse files

Make the (doxygen) doc target depend on matfaust files filtering targets to...

Make the (doxygen) doc target depend on matfaust files filtering targets to allow fix missing code doc (bed65cb6 regression).
parent 89051fa4
Branches
Tags 2.5.61rc0 2.5.61rc1
No related merge requests found
Pipeline #833941 skipped
...@@ -12,6 +12,7 @@ if(BUILD_DOCUMENTATION) ...@@ -12,6 +12,7 @@ if(BUILD_DOCUMENTATION)
if(BUILD_WRAPPER_PYTHON) if(BUILD_WRAPPER_PYTHON)
string(CONCAT DOXYGEN_FILE_PATTERNS ${DOXYGEN_FILE_PATTERNS} "__init__.py factparams.py demo.py tools.py fact.py proj.py") string(CONCAT DOXYGEN_FILE_PATTERNS ${DOXYGEN_FILE_PATTERNS} "__init__.py factparams.py demo.py tools.py fact.py proj.py")
endif() endif()
#message(STATUS DOXYGEN_FILE_PATTERNS=${DOXYGEN_FILE_PATTERNS})
configure_file(${FAUST_DOC_SRC_DIR}/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile @ONLY) 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. # ./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}/py_filterout_namespace.py ${PROJECT_BINARY_DIR}/doc/py_filterout_namespace.py @ONLY)
...@@ -29,6 +30,9 @@ if(BUILD_DOCUMENTATION) ...@@ -29,6 +30,9 @@ if(BUILD_DOCUMENTATION)
add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM) add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM)
else() else()
add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile DEPENDS zip_notebooks WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM) add_custom_target(doc ALL ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/Doxyfile DEPENDS zip_notebooks WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Generating API documentation with Doxygen" VERBATIM)
if(BUILD_WRAPPER_MATLAB)
add_dependencies(doc PREPARE_MATFAUST_FOR_DOXYDOC)
endif()
endif() endif()
#list(GET <list> <element index> [<index> ...] <out-var>) #list(GET <list> <element index> [<index> ...] <out-var>)
list(GET PYTHON_EXES -1 PY3_EXE) list(GET PYTHON_EXES -1 PY3_EXE)
......
...@@ -464,7 +464,8 @@ INPUT = "@PROJECT_BINARY_DIR@/doc/mainpage.md" \ ...@@ -464,7 +464,8 @@ INPUT = "@PROJECT_BINARY_DIR@/doc/mainpage.md" \
"@FAUST_ALGORITHM_FACTORIZATION_SRC_DIR@" \ "@FAUST_ALGORITHM_FACTORIZATION_SRC_DIR@" \
"@FAUST_BIN_CMDLINE_SRC_DIR@" \ "@FAUST_BIN_CMDLINE_SRC_DIR@" \
"@FAUST_BIN_TEST_SRC_DIR@" \ "@FAUST_BIN_TEST_SRC_DIR@" \
@FAUST_PYTHON_BIN_DIR@ @PROJECT_BINARY_DIR@/@FAUST_MATLAB_BIN_DIR@ "@FAUST_PYTHON_BIN_DIR@" \
"@FAUST_MATLAB_BIN_DIR@"
USE_MDFILE_AS_MAINPAGE = mainpage USE_MDFILE_AS_MAINPAGE = mainpage
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
...@@ -517,7 +518,7 @@ EXCLUDE_SYMLINKS = NO ...@@ -517,7 +518,7 @@ EXCLUDE_SYMLINKS = NO
# against the file with absolute path, so to exclude all test directories # against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/* # for example use the pattern */test/*
EXCLUDE_PATTERNS = *faust_MatDense_gpu.h *faust_MatSparse_gpu.h EXCLUDE_PATTERNS = *faust_MatDense_gpu.h *faust_MatSparse_gpu.h expfiltered*
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 is_mat_consistent init_facts stop_crit ParamsPalm4MSAFGFT data_num_cols data_num_rows is_fact_side_left stop_crits constant_step_size constraints DISABLED_OPT EXTERNAL_OPT grad_calc_opt_mode init_lambda INTERNAL_OPT is_update_way_R2L is_verbose num_facts step_size IDX_IS_FACT_SIDE_LEFT OPT_ARG_NAMES2 OPT_ARG_NAMES DEFAULT_OPT IDX_USE_CSR IDX_NORM2_MAX_ITER IDX_NORM2_THRESHOLD IDX_GRAD_CALC_OPT_MODE IDX_VERBOSITY IDX_CONSTANT_STEP_SIZE IDX_STEP_SIZE IDX_INIT_LAMBDA IDX_IS_UPDATE_WAY_R2L 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 is_mat_consistent init_facts stop_crit ParamsPalm4MSAFGFT data_num_cols data_num_rows is_fact_side_left stop_crits constant_step_size constraints DISABLED_OPT EXTERNAL_OPT grad_calc_opt_mode init_lambda INTERNAL_OPT is_update_way_R2L is_verbose num_facts step_size IDX_IS_FACT_SIDE_LEFT OPT_ARG_NAMES2 OPT_ARG_NAMES DEFAULT_OPT IDX_USE_CSR IDX_NORM2_MAX_ITER IDX_NORM2_THRESHOLD IDX_GRAD_CALC_OPT_MODE IDX_VERBOSITY IDX_CONSTANT_STEP_SIZE IDX_STEP_SIZE IDX_INIT_LAMBDA IDX_IS_UPDATE_WAY_R2L
......
...@@ -27,6 +27,7 @@ endforeach() ...@@ -27,6 +27,7 @@ endforeach()
#message(FATAL_ERROR ${FAUST_MATLAB_MATFAUST_FILE_LIST}) #message(FATAL_ERROR ${FAUST_MATLAB_MATFAUST_FILE_LIST})
add_custom_target(PREPARE_MATFAUST_FOR_DOXYDOC ALL)
foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST) foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST)
string(REGEX REPLACE "[^+]*\\+matfaust\\/" "" MATFAUST_FILE ${MATFAUST_FILE}) string(REGEX REPLACE "[^+]*\\+matfaust\\/" "" MATFAUST_FILE ${MATFAUST_FILE})
get_filename_component(PARENT_DIR ${MATFAUST_FILE} DIRECTORY) get_filename_component(PARENT_DIR ${MATFAUST_FILE} DIRECTORY)
...@@ -70,7 +71,6 @@ foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST) ...@@ -70,7 +71,6 @@ foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST)
#execute_process(COMMAND ${PROJECT_SOURCE_DIR}/gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} ERROR_QUIET) #execute_process(COMMAND ${PROJECT_SOURCE_DIR}/gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh ${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} ERROR_QUIET)
#TODO: copy if error (fallback solution) #TODO: copy if error (fallback solution)
#configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} COPYONLY) #configure_file(${FAUST_MATLAB_NAMESPACE_SRC_DIR}/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} COPYONLY)
add_custom_target(GEN_MATFAUST_INLINE_DOC_${MATFAUST_SHORT_FILE} ALL DEPENDS ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE})
else() else()
message(STATUS "matfaust function file: " ${MATFAUST_FILE}) message(STATUS "matfaust function file: " ${MATFAUST_FILE})
# just copy the .m # just copy the .m
...@@ -81,8 +81,9 @@ foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST) ...@@ -81,8 +81,9 @@ foreach(MATFAUST_FILE IN LISTS FAUST_MATLAB_MATFAUST_FILE_LIST)
ARGS ${PROJECT_SOURCE_DIR}/gen_doc/matlab_copy_function_file.py ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE} ARGS ${PROJECT_SOURCE_DIR}/gen_doc/matlab_copy_function_file.py ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE} ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE}
DEPENDS ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE} DEPENDS ${FAUST_MATLAB_BIN_DIR}/expfiltered/${MATFAUST_FILE}
COMMENT "Generating matfaust inline doc for ${MATFAUST_FILE} (just copied because it's a function file).") COMMENT "Generating matfaust inline doc for ${MATFAUST_FILE} (just copied because it's a function file).")
add_custom_target(GEN_MATFAUST_INLINE_DOC_${MATFAUST_SHORT_FILE} ALL DEPENDS ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE})
endif() endif()
add_custom_target(GEN_MATFAUST_INLINE_DOC_${MATFAUST_SHORT_FILE} ALL DEPENDS ${FAUST_MATLAB_NAMESPACE_BIN_DIR}/${MATFAUST_FILE})
add_dependencies(PREPARE_MATFAUST_FOR_DOXYDOC GEN_MATFAUST_INLINE_DOC_${MATFAUST_SHORT_FILE})
endforeach() endforeach()
file(GLOB CPP_MEXTOOLS_FILES "${FAUST_MATLAB_TOOLS_SRC_DIR}/*.cpp") file(GLOB CPP_MEXTOOLS_FILES "${FAUST_MATLAB_TOOLS_SRC_DIR}/*.cpp")
...@@ -144,7 +145,7 @@ foreach(mex_target ${MEXFILE_TARGET_LIST}) ...@@ -144,7 +145,7 @@ foreach(mex_target ${MEXFILE_TARGET_LIST})
target_compile_options(${mex_target} PRIVATE "/VERBOSE") # doesn't work at least with MSVC target_compile_options(${mex_target} PRIVATE "/VERBOSE") # doesn't work at least with MSVC
# complete static libs (linked later) by objects of libs if needed (fallback solution from environment) # complete static libs (linked later) by objects of libs if needed (fallback solution from environment)
target_link_options(${mex_target} PRIVATE $ENV{WIN_HDF5_OBJS_DIR}/*.obj $ENV{WIN_SZIP_OBJS_DIR}/*.obj) target_link_options(${mex_target} PRIVATE $ENV{WIN_HDF5_OBJS_DIR}/*.obj $ENV{WIN_SZIP_OBJS_DIR}/*.obj)
target_compile_definitions(${mex_target} PRIVATE NOMINMAX MATLAB_DEFAULT_RELEASE=R2017b) target_compile_definitions(${mex_target} PRIVATE NOMINMAX MATLAB_DEFAULT_RELEASE=R2017b) # it seems necessary for windows while R2017b flag of matlab_add_mex is enough for Unix
else() else()
target_link_options(${mex_target} PRIVATE ${OpenMP_CXX_LIBRARIES}) # do nothing if BUILD_MULTITHREAD is OFF target_link_options(${mex_target} PRIVATE ${OpenMP_CXX_LIBRARIES}) # do nothing if BUILD_MULTITHREAD is OFF
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment