Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 109425a8 authored by hhakim's avatar hhakim
Browse files

Remove matlab files .m form feed character filter (added by 9938837f) by... 

Remove matlab files .m form feed character filter (added by 9938837f) by correcting the bug at its source in gen_matlab_inline_doc_from_doxy_blocks.sh.

Basically, removing the -e option of echo to avoid interpreting escape characters.
Added by the way more filters of HTML tags (we don't want them in inline doc).
parent c1fae822
No related branches found
No related tags found
Hide whitespace changes
Inline Side-by-side
gen_doc/CMakeLists.txt
+ 19
− 25
View file @ 109425a8
...@@ -58,31 +58,25 @@ if(BUILD_DOCUMENTATION) ...@@ -58,31 +58,25 @@ if(BUILD_DOCUMENTATION)
add_dependencies(doc PREPARE_MATFAUST_FOR_DOXYDOC) add_dependencies(doc PREPARE_MATFAUST_FOR_DOXYDOC)
endif() 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)
set(GLOB_PATTS "'${PROJECT_BINARY_DIR}/doc/html/namespacepyfaust_*.html';'${PROJECT_BINARY_DIR}/doc/html/namespacematfaust_*.html'") set(GLOB_PATTS "'${PROJECT_BINARY_DIR}/doc/html/namespacepyfaust_*.html';'${PROJECT_BINARY_DIR}/doc/html/namespacematfaust_*.html'")
if(NOT PY3_EXE) if(NOT PY3_EXE)
# workaround in case BUILD_WRAPPER_PYTHON is OFF which implies PY3_EXE is not set # workaround in case BUILD_WRAPPER_PYTHON is OFF which implies PY3_EXE is not set
set(PY3_EXE python3) set(PY3_EXE python3)
endif() endif()
add_custom_target(doc_exclu_class_filtering ALL ${PY3_EXE} add_custom_target(doc_exclu_class_filtering ALL ${PY3_EXE}
${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py ${GLOB_PATTS} DEPENDS doc WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Filter out the non-documented classes") ${PROJECT_BINARY_DIR}/doc/filterout_excluded_classes.py ${GLOB_PATTS} DEPENDS doc WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc COMMENT "Filter out the non-documented classes")
if(BUILD_WRAPPER_MATLAB)
if(UNIX)
add_custom_target(filterout_formfeeds ALL find ${PROJECT_BINARY_DIR}/wrapper/matlab/+matfaust/ -name '*.m' -exec sed -i 's/\\f//g' '{}' \\\; DEPENDS doc WORKING_DIRECTORY ${PROJECT_BINARY_DIR} COMMENT "Filtering out the formfeeds characters.")
elseif(WIN32)
add_custom_target(filterout_formfeeds ALL ${SH_CMD} -c "find ${PROJECT_BINARY_DIR}/wrapper/matlab/+matfaust/ -name '*.m' -exec sed -i 's/\\f//g' '{}' \\\;" DEPENDS doc WORKING_DIRECTORY ${PROJECT_BINARY_DIR} COMMENT "Filtering out the formfeeds characters.")
endif(UNIX)
endif(BUILD_WRAPPER_MATLAB)
#install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION doc/share/doc) #install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION doc/share/doc)
#file(MAKE_DIRECTORY ${FAUST_INSTALL_DOC}) #file(MAKE_DIRECTORY ${FAUST_INSTALL_DOC})
#install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${FAUST_INSTALL_DOC} FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE) #install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${FAUST_INSTALL_DOC} FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE)
string(TIMESTAMP DOXYGEN_CURRENT_DATE "%Y-%m-%d - %H:%M") string(TIMESTAMP DOXYGEN_CURRENT_DATE "%Y-%m-%d - %H:%M")
if(EXCLUDE_FAUST_LIB_INSTALL) if(EXCLUDE_FAUST_LIB_INSTALL)
file(READ mainpage_wrappers_inc.md INCLUDE_SPECIFIC_DOC) file(READ mainpage_wrappers_inc.md INCLUDE_SPECIFIC_DOC)
configure_file(${FAUST_DOC_SRC_DIR}/install_pyfaust_in_venv.md ${PROJECT_BINARY_DIR}/doc//install_pyfaust_in_venv.md) configure_file(${FAUST_DOC_SRC_DIR}/install_pyfaust_in_venv.md ${PROJECT_BINARY_DIR}/doc//install_pyfaust_in_venv.md)
else() else()
file(READ mainpage_cpp_inc.md INCLUDE_SPECIFIC_DOC) file(READ mainpage_cpp_inc.md INCLUDE_SPECIFIC_DOC)
endif() endif()
configure_file(${FAUST_DOC_SRC_DIR}/mainpage.md ${PROJECT_BINARY_DIR}/doc/mainpage.md) configure_file(${FAUST_DOC_SRC_DIR}/mainpage.md ${PROJECT_BINARY_DIR}/doc/mainpage.md)
...@@ -113,23 +107,23 @@ if(BUILD_DOCUMENTATION) ...@@ -113,23 +107,23 @@ if(BUILD_DOCUMENTATION)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/installer_readme.html.in ${PROJECT_BINARY_DIR}/doc/installer_readme.html @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/installer_readme.html.in ${PROJECT_BINARY_DIR}/doc/installer_readme.html @ONLY)
file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/licenses.html DESTINATION ${PROJECT_BINARY_DIR}/doc/) file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/licenses.html DESTINATION ${PROJECT_BINARY_DIR}/doc/)
if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS) if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS) file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
endif() endif()
#file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/README.html DESTINATION ${PROJECT_BINARY_DIR}/doc/html/) #file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/macosx/README.html DESTINATION ${PROJECT_BINARY_DIR}/doc/html/)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY)
elseif(UNIX) elseif(UNIX)
#file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/linux/README.html DESTINATION ${PROJECT_BINARY_DIR}/doc/html/) #file(COPY ${FAUST_DOC_SRC_DIR}/bin_pkgs/linux/README.html DESTINATION ${PROJECT_BINARY_DIR}/doc/html/)
if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS) if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/linux/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/linux/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS) file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
endif() endif()
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY)
elseif(WIN32) elseif(WIN32)
SET(FAUST_INSTALL_PATH "C:/Program Files/Faust") # path of installation is always this on Windows SET(FAUST_INSTALL_PATH "C:/Program Files/Faust") # path of installation is always this on Windows
if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS) if(NOT DEFINED OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/win/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/win/README_install_part.html ${PROJECT_BINARY_DIR}/doc/README_install_part.html)
file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS) file(READ ${PROJECT_BINARY_DIR}/doc/README_install_part.html OS_SPECIFIC_INSTALL_GUIDE_INSTRUCS)
endif() endif()
configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY) configure_file(${FAUST_DOC_SRC_DIR}/bin_pkgs/README_template.html ${PROJECT_BINARY_DIR}/doc/html/README.html @ONLY)
......
gen_doc/gen_matlab_inline_doc_from_doxy_blocks.sh
+ 11
− 7
View file @ 109425a8
...@@ -18,7 +18,7 @@ function usage_exit { ...@@ -18,7 +18,7 @@ function usage_exit {
function parse_doxy_block { function parse_doxy_block {
local FUNC=$(echo $1 | tr '[a-z]' '[A-Z]') local FUNC=$(echo $1 | tr '[a-z]' '[A-Z]')
local FUNC_LINE=$(echo "$3" | sed -e 's/^[[:blank:]]\{1,\}//') local FUNC_LINE=$(echo "$3" | sed -e 's/^[[:blank:]]\{1,\}//')
echo -e "$2" | sed -e "{ echo "$2" | sed -e "{
s/^[[:blank:]]*%=\{4,\}//; s/^[[:blank:]]*%=\{4,\}//;
s/%>[[:blank:]]*@brief/%% $FUNC/; s/%>[[:blank:]]*@brief/%% $FUNC/;
s/^\([[:blank:]]\{1,\}\)%> @param F/\1% SPECS: $FUNC_LINE:\n\1\t% - Parameter F: /; s/^\([[:blank:]]\{1,\}\)%> @param F/\1% SPECS: $FUNC_LINE:\n\1\t% - Parameter F: /;
...@@ -28,13 +28,17 @@ function parse_doxy_block { ...@@ -28,13 +28,17 @@ function parse_doxy_block {
s/@param[[:blank:]]\([^[:blank:]]\{1,\}\)/- Parameter \1: /; s/@param[[:blank:]]\([^[:blank:]]\{1,\}\)/- Parameter \1: /;
s/@code/=========== code ===========/; s/@code/=========== code ===========/;
s/@endcode/========= end code =========/; s/@endcode/========= end code =========/;
s/\(Examples\{0,1\}\)/\1:/ s/\(Examples\{0,1\}\)/\1:/;
s/<[^>]*>//g; #s/<[^>]*>//g;
s/<b>//g;
s/<\/b>//g;
s/<br\/>//g;
s/<p>//g;
s/<img.*src=\"\([^\"]\{1,\}\)\".*\/>/\1/g;
s/&nbsp;/ /g; s/&nbsp;/ /g;
s/@retval/Returns/g; s/@retval/Returns/g;
s/@warning/Warning:/g; s/@warning/Warning:/g;
s/@[^[:blank:]]* \{0,1\}//g; s/@[^[:blank:]]* \{0,1\}//g;
s/\\\./\./g
}" }"
} }
...@@ -96,7 +100,7 @@ do ...@@ -96,7 +100,7 @@ do
sed -ne '1,'$FUNC_LINE'p' $OUTPUT_FILE > ${OUTPUT_FILE}_tmp sed -ne '1,'$FUNC_LINE'p' $OUTPUT_FILE > ${OUTPUT_FILE}_tmp
# parse doxy block for inline block # parse doxy block for inline block
INLINE_BLOCK=$(parse_doxy_block $FUNC "$DOXY_BLOCK" "$FUNC_DEF_LINE") INLINE_BLOCK=$(parse_doxy_block $FUNC "$DOXY_BLOCK" "$FUNC_DEF_LINE")
echo -e "$INLINE_BLOCK" >> ${OUTPUT_FILE}_tmp echo "$INLINE_BLOCK" >> ${OUTPUT_FILE}_tmp
sed -ne $(($FUNC_LINE+1))','$(wc -l ${OUTPUT_FILE} | awk '{print $1}')'p' $OUTPUT_FILE >> ${OUTPUT_FILE}_tmp sed -ne $(($FUNC_LINE+1))','$(wc -l ${OUTPUT_FILE} | awk '{print $1}')'p' $OUTPUT_FILE >> ${OUTPUT_FILE}_tmp
[ "$?" = 0 ] && mv ${OUTPUT_FILE}_tmp ${OUTPUT_FILE} [ "$?" = 0 ] && mv ${OUTPUT_FILE}_tmp ${OUTPUT_FILE}
DOXY_BLOCK_ID+=2 DOXY_BLOCK_ID+=2
...@@ -112,7 +116,7 @@ DOXY_HEADER=$(sed -ne "$((${HEADER_START_END[0]}+1)),$((${HEADER_START_END[1]}-1 ...@@ -112,7 +116,7 @@ DOXY_HEADER=$(sed -ne "$((${HEADER_START_END[0]}+1)),$((${HEADER_START_END[1]}-1
[[ "$DEBUG" = "DOXY_HEADER" ]] && echo "DOXY_HEADER=$DOXY_HEADER" [[ "$DEBUG" = "DOXY_HEADER" ]] && echo "DOXY_HEADER=$DOXY_HEADER"
INLINE_HEADER=$(parse_doxy_block "FAUST" "$DOXY_HEADER") INLINE_HEADER=$(parse_doxy_block "FAUST" "$DOXY_HEADER")
[[ "$DEBUG" = "INLINE_HEADER" ]] && echo "INLINE_HEADER=$INLINE_HEADER" [[ "$DEBUG" = "INLINE_HEADER" ]] && echo "INLINE_HEADER=$INLINE_HEADER"
echo -e "$INLINE_HEADER" | sed 's/^[[:blank:]]\{1,\}//' > ${OUTPUT_FILE}_tmp echo "$INLINE_HEADER" | sed 's/^[[:blank:]]\{1,\}//' > ${OUTPUT_FILE}_tmp
echo -e '\n\n' >> ${OUTPUT_FILE}_tmp echo -e '\n\n' >> ${OUTPUT_FILE}_tmp
sed -ne "${HEADER_START_END[0]},${OUT_NUM_LINES}p" $OUTPUT_FILE >> ${OUTPUT_FILE}_tmp sed -ne "${HEADER_START_END[0]},${OUT_NUM_LINES}p" $OUTPUT_FILE >> ${OUTPUT_FILE}_tmp
[ "$?" = 0 ] && mv ${OUTPUT_FILE}_tmp ${OUTPUT_FILE} [ "$?" = 0 ] && mv ${OUTPUT_FILE}_tmp ${OUTPUT_FILE}
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment