簡介
使用ipad閱讀代碼
https://www.zhihu.com/collection/64510384
https://www.cnblogs.com/benjamin-t/p/3618787.html
下面進行補充
安裝完doxygen后即可進行適當的配置,然后運行doxyfile生成文檔。基本的配置前人早有說明,不再贅述。需要注意的是:
1.要勾選Dot選項卡下面的HAVE_DOT、CALL_GRAPH 、CALLER_GRAPH 選項。並在DOT_PATH下面填入dot.exe的路徑,也就是graphviz安裝目錄下的bin文件夾。
2.勾選Wizard->Project選項卡下面的Scan recursively!
3.勾選Build選項卡下面的EXTRACT_ALL、EXTRACT_PRIVATE、EXTRACT_STATIC、EXTRACT_LOCAL_CLASSES、EXTRACT_LOCAL_METHODS選項
4.如果程序里面有中文,將Project選項卡下的DOXYFILE_ENCODING和Input選項卡下面的INPUT_ENCODING改為GBK
5.可以勾掉LATEX輸出,這樣節省編譯時間
在linux上成功了在windows上失敗了
INPUT = protobuf-2.5.0/src (設置項目源代碼目錄的路徑,相對於Doxyfile的位置)
PROJECT_NAME = "ProtoBuf" (項目名默認為My Project)
OUTPUT_DIRECOTRY = doc (設置文檔輸出路徑,相對於Doxyfile的位置)
RECURSIVE = YES (設置遞歸查找所有子目錄,默認NO只查找當前目錄)
EXTRACT_ALL = YES (設置抽取代碼中所有實體,默認NO只抽取有doxygen注釋的實體)
SOURCE_BROWSER = YES (生成交叉引用)
INLINE_SOURCES = YES (將源代碼包含進文檔,默認NO只包含聲明,不包含定義)
OUTPUT_LANGUAGE = Chinese (設置文檔語言為中文)
Tips
記得在latex目錄下使用make來生成最終版。