在cmake中使用doxygen生成document
2015-01-14 20:11
344 查看
1. 首先在CMakeLists.txt中添加如下的代码:
代码取自:http://www.tty1.net/blog/2014/cmake-doxygen_en.html
cmake相关document见:http://www.cmake.org/cmake/help/v3.0/
2. 在Project的目录下创建Doxyfile.in文件,其内容如下,可跟据需要自行添加参数设定。
document见:http://www.stack.nl/~dimitri/doxygen/manual/config.html
3. 使用cmake生成makefile后,即可使用make doc来生成document。
代码取自:http://www.tty1.net/blog/2014/cmake-doxygen_en.html
cmake相关document见:http://www.cmake.org/cmake/help/v3.0/
# add a target to generate API documentation with Doxygen FIND_PACKAGE(Doxygen) OPTION(BUILD_DOCUMENTATION "Create and install the HTML based API documentation (requires Doxygen)" ${DOXYGEN_FOUND}) IF(BUILD_DOCUMENTATION) IF(NOT DOXYGEN_FOUND) MESSAGE(FATAL_ERROR "Doxygen is needed to build the documentation.") ENDIF() SET(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) SET(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) CONFIGURE_FILE(${doxyfile_in} ${doxyfile} @ONLY) ADD_CUSTOM_TARGET(doc COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM) INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc) ENDIF()
2. 在Project的目录下创建Doxyfile.in文件,其内容如下,可跟据需要自行添加参数设定。
document见:http://www.stack.nl/~dimitri/doxygen/manual/config.html
PROJECT_NAME = "@CMAKE_PROJECT_NAME@" PROJECT_NUMBER = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@ STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ \ @PROJECT_BINARY_DIR@ INPUT = @doxy_main_page@ \ @PROJECT_SOURCE_DIR@ \ @PROJECT_BINARY_DIR@ FILE_PATTERNS = *.h \ *.cpp RECURSIVE = YES EXTRACT_ALL = YES EXTRACT_PRIVATE = YES EXTRACT_STATIC = YES EXCLUDE_PATTERNS = */thirdparty/* USE_MDFILE_AS_MAINPAGE = @doxy_main_page@
3. 使用cmake生成makefile后,即可使用make doc来生成document。
相关文章推荐
- 使用Doxygen生成libevent document(2.0.15)--CHM格式
- 使用Doxygen生成libevent document
- 使用Doxygen生成libevent document(2.0.15)--CHM格式
- 使用doxygen从c++代码中生成文档的方法学习 .
- 【转】使用doxygen为C/C++程序生成中文文档(上)
- 使用cmake生成osg解决方案时尤其要注意!!!
- 使用asDoc生成自己的Flex API Document
- 使用doxygen为C/C++程序生成中文文档
- 使用 Document!X 为自己的dll生成一个漂亮的说明文档
- 使用JavaDoc风格注释让doxygen自动生成文档
- 使用doxygen为C/C++程序生成中文文档(上)
- 使用Doxygen生成全中文的chm帮助文档
- 使用doxygen为C/C++程序生成中文文档(上)
- “looks like we got no XML document”——使用Zend Studio9生成WSDL遇到的错误
- Doxygen文档生成工具的使用
- 使用Doxygen生成全中文的chm帮助文档
- doxygen 帮助手册生成使用心得
- 学习使用 doxygen 生成源码文档
- 如何在Windows下使用CMake 2.8.2生成Ogre 1.7.1工程文件
- 如何使用CMAKE生成makefile文件