Doxygen 的使用

1. 安裝

  • OS X
$ brew install doxygen
$ brew install graphviz
  • Ubuntu/Debian
$ sudo apt-get install doxygen
$ sudo apt-get install graphviz

2. 使用方法

  • 生成配置文件
doxygen -g

會在當前目錄下生成一個 DoxyFile 文件

  • 修改配置
    修改 DoxyFile 文件,主要修改以下幾項:
    CALL_GRAPH = YES
    HAVE_DOT = YES
    RECURSIVE = YES (遞歸檢索文件)
    過濾不必要的目錄
EXCLUDE_PATTERNS = */.git/*
EXCLUDE_PATTERNS += */docs/*
EXCLUDE_PATTERNS += */test/*
  • 生成
doxygen DoxyFile

執行完成后可以在當前目錄下看到一個 html 目錄和 latex 目錄,直接打開 html/index.html 即可看到結果。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容