由於工作原因,使用了Doxygen工具來生成一些相關文檔。以下是使用記錄
1 生成配置文件:
doxygen –g xxx.docx
2 編輯配置文件
後面說明
3 生成文檔: doxygen xxx.docx
4 其中編譯配置文件是裏面比較麻煩的工作,我的配置記錄如下:
PROJECT_LOGO = ./doc_logo.jpeg // 這個會Copy到Html的生成目錄中去,效果是首頁左上角有個你自定義的圖標,這個對於圖片大小有需求
OUTPUT_LANGUAGE = Chinese
EXTRACT_ALL = YES // 解析所有成員
EXTRACT_PRIVATE = YES // 這個其實應該包含於上面的
GENERATE_TODOLIST = YES // 這個可以解析 @todo相關的註釋
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_PATTERNS = *.h .... // 將你需要解析的文件放到裏面
FILE_PATTERNS = *.qml \
*.h \
*.cpp \
*.js \
*.dox
RECURSIVE = YES
FILTER_PATTERNS = *.qml=/usr/local/bin/doxyqml
INCLUDE_FILE_PATTERNS = *.cpp \
*.h \
*.qml \
*.js
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_MULTI_TARGETS = YES
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
以上的效果是生成一些帶有UML圖的文檔,但是前提條件是安裝 Graphviz
5 生成PDF文檔,但是貌似有中文的話就會出現一些問題
在生成後的Latex中執行make來生成PDF文檔
6 首頁的自定義一個文件mainpage.dox,一個功能只能有一個
//!\mainpage caption
//! AAAAA
7 如何定義首頁需要顯示的自定義圖片?
//!\mainpage caption
//!AAAA:
//!\image html ./whole.png "caption" <size>
這個SIZE我沒搞懂,但是可以顯示自定義圖片,唯一要注意的是要把這寫文件copy到html下,或者寫成絕對目錄