Files
uLib/CMake/uLibGenerateDoc.cmake
2019-05-10 09:08:26 +00:00

98 lines
3.1 KiB
CMake

find_package(Doxygen)
set(doxydirlist "")
foreach(modname ${ULIB_SELECTED_MODULES})
set(doxydirlist "${CMAKE_CURRENT_SOURCE_DIR}/src/${modname} ${doxydirlist}")
endforeach(modname)
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
"PROJECT_NAME=${CMAKE_PROJECT_NAME}-${PACKAGE_VERSION}\n"
"OUTPUT_DIRECTORY=${CMAKE_CURRENT_BINARY_DIR}\n"
"CREATE_SUBDIRS=NO\n"
"OUTPUT_LANGUAGE=English\n"
"BRIEF_MEMBER_DESC=YES\n"
"REPEAT_BRIEF=YES\n"
"ALWAYS_DETAILED_SEC=NO\n"
"INLINE_INHERITED_MEMB=NO\n"
"STRIP_FROM_INC_PATH=${CMAKE_CURRENT_SOURCE_DIR}/src\n"
"FULL_PATH_NAMES=YES\n"
"STRIP_FROM_PATH=${CMAKE_CURRENT_SOURCE_DIR}/src\n"
"SHORT_NAMES=NO\n"
"MULTILINE_CPP_IS_BRIEF=NO\n"
"INHERIT_DOCS=YES\n"
"DISTRIBUTE_GROUP_DOC=NO\n"
"OPTIMIZE_OUTPUT_FOR_C=YES\n"
"SUBGROUPING=YES\n"
"EXTRACT_ALL=YES\n"
"EXTRACT_PRIVATE=NO\n"
"EXTRACT_STATIC=NO\n"
"EXTRACT_LOCAL_CLASSES=YES\n"
"EXTRACT_LOCAL_METHODS=NO\n"
"HIDE_UNDOC_MEMBERS=NO\n"
"HIDE_UNDOC_CLASSES=NO\n"
"HIDE_FRIEND_COMPOUNDS=NO\n"
"HIDE_IN_BODY_DOCS=NO\n"
"INTERNAL_DOCS=NO\n"
"CASE_SENSE_NAMES=NO\n"
"HIDE_SCOPE_NAMES=NO\n"
"SHOW_INCLUDE_FILES=YES\n"
"INLINE_INFO=YES\n"
"SORT_MEMBER_DOCS=YES\n"
"SORT_BRIEF_DOCS=NO\n"
"SORT_BY_SCOPE_NAME=NO\n"
"GENERATE_TODOLIST=YES\n"
"GENERATE_TESTLIST=YES\n"
"GENERATE_BUGLIST=YES\n"
"GENERATE_DEPRECATEDLIST=YES\n"
"MAX_INITIALIZER_LINES=30\n"
"SHOW_USED_FILES=YES\n"
"QUIET=YES\n"
"WARNINGS=NO\n"
"WARN_IF_UNDOCUMENTED=YES\n"
"WARN_IF_DOC_ERROR=YES\n"
"WARN_FORMAT=\"$file:$line: $text\"\n"
"INPUT=${doxydirlist}\n"
"FILE_PATTERNS=*.h *.hpp\n"
"ENABLE_PREPROCESSING=YES\n"
"MACRO_EXPANSION=YES\n"
"RECURSIVE=YES\n"
"EXCLUDE_SYMLINKS=NO\n"
"FILTER_SOURCE_FILES=NO\n"
"SOURCE_BROWSER=NO\n"
"INLINE_SOURCES=NO\n"
"STRIP_CODE_COMMENTS=YES\n"
"REFERENCED_BY_RELATION=YES\n"
"REFERENCES_RELATION=YES\n"
"VERBATIM_HEADERS=YES\n"
"ALPHABETICAL_INDEX=YES\n"
"COLS_IN_ALPHA_INDEX=5\n"
"GENERATE_HTML=YES\n"
"HTML_OUTPUT=html\n"
"HTML_FILE_EXTENSION=.html\n"
"GENERATE_HTMLHELP=NO\n"
"BINARY_TOC=NO\n"
"TOC_EXPAND=NO\n"
"DISABLE_INDEX=NO\n"
"ENUM_VALUES_PER_LINE=4\n"
"GENERATE_TREEVIEW=YES\n"
"TREEVIEW_WIDTH=250\n"
"GENERATE_LATEX=NO\n"
"GENERATE_RTF=NO\n"
"GENERATE_MAN=NO\n"
"GENERATE_XML=NO\n"
"GENERATE_AUTOGEN_DEF=NO\n"
"GENERATE_PERLMOD=NO\n")
option(NODOXYGEN "Disable the creation of the API documentation")
if(NODOXYGEN OR (NOT DOXYGEN_FOUND))
message("Doxygen is disabled or not installed")
else(NODOXYGEN OR (NOT DOXYGEN_FOUND))
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
COMMAND doxygen ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg)
add_custom_target(doxygen ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/index.html)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION share/doc/${PACKAGE_NAME})
endif(NODOXYGEN OR (NOT DOXYGEN_FOUND))