Linux下Doxygen的安裝和使用

一、簡介
Doxygen是一種開源跨平台的，以類似JavaDoc風格描述的文件系統，完全支援C、C++、Java、Objective-C和IDL語言，部分支援PHP、C#。注釋的語法與Qt-Doc、KDoc和JavaDoc相容。Doxgen可以從一套歸檔原始檔開始，生成HTML格式的線上類瀏覽器，或離線的LATEX、RTF參考手冊。
 
二、安裝
需安裝doxygen和用於支援doxygen的影象化工具graphviz，步驟如下：
 
1、安裝doxygen
1、資源下載：doxygen-1.7.4.linux.bin.tar.gz
http://www.stack.nl/~dimitri/doxygen/download.html
2、編譯安裝
1)  tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2)  cd doxygen-1.7.4
3)  ./configure
4)  make
5)  make install
 
2、安裝graphviz
1、執行如下命令即可完成安裝
yum install graphviz

 
三、設定使用
1、在專案工程目錄下生成組態檔
cd test/            #進入專案目錄（test為例說明）
Doxygen –g        #生成組態檔
提示：
1、預設生成的組態檔名為 "Doxyfile"，也可以指定生成的組態檔名：doxygen -g your-cfg-filename
 
2、可以在生成組態檔的命令中新增 "-s" 選項，生成不含註釋的組態檔：doxygen -sg
 
2、根據需要，修改組態檔
模板下載：

------------------------------------------分割線------------------------------------------

免費下載地址在 http://linux.linuxidc.com/

使用者名稱與密碼都是www.linuxidc.com

具體下載目錄在 /2015年資料/4月/23日/Linux下Doxygen的安裝和使用/

下載方法見 http://www.linuxidc.com/Linux/2013-07/87684.htm

------------------------------------------分割線------------------------------------------

常用選項如下：

# 專案名稱，將作為於所生成的程式文件首頁標題
PROJECT_NAME        = “Test”
# 文件版本號，可對應於專案版本號，譬如 svn、cvs 所生成的專案版本號
PROJECT_NUMBER      = "1.0.0
# 程式文件輸出目錄
OUTPUT_DIRECTORY    =  /home/user1/docs
 
# 程式文件輸入目錄
INPUT                = /home/user1/project/kernel
 
# 程式文件語言環境
OUTPUT_LANGUAGE      = Chinese
 
# 只對標頭檔案中的文件化資訊生成程式文件
FILE_PATTERNS        =
 
# 遞回遍歷當前目錄的子目錄，尋找被文件化的程式原始檔
RECURSIVE            = YES
# 如果是製作 C 程式文件，該選項必須設為 YES，否則預設生成 C++ 文件格式
OPTIMIZE_OUTPUT_FOR_C  = YES
 
#提取資訊，包含類的私有資料成員和靜態成員
EXTRACT_ALL            = yes
EXTRACT_PRIVATE        = yes
EXTRACT_STATIC        = yes
# 對於使用 typedef 定義的結構體、列舉、聯合等資料型別，只按照 typedef 定義的型別名進行文件化
TYPEDEF_HIDES_STRUCT  = YES
# 在 C++ 程式文件中，該值可以設定為 NO，而在 C 程式文件中，由於 C 語言沒有所謂的域/命名空間這樣的概念，所以此處設定為 YES
HIDE_SCOPE_NAMES      = YES
# 讓 doxygen 靜悄悄地為你生成文件，只有出現警告或錯誤時，才在終端輸出提示資訊
QUIET  = YES
# 遞回遍歷範例程式目錄的子目錄，尋找被文件化的程式原始檔
EXAMPLE_RECURSIVE      = YES
# 允許程式文件中顯示本文件化的函數相互呼叫關係
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程式文件
GENERATE_LATEX        = NO
# 在程式文件中允許以圖例形式顯示函數呼叫關係，前提是你已經安裝了 graphviz 軟體包
HAVE_DOT              = YES
CALL_GRAPH            = YES
CALLER_GRAPH          = YES
#在最後生成的文件中，把所有的原始碼包含在其中
SOURCE BROWSER        = YES
$這會在HTML文件中，新增一個側邊欄，並以樹狀結構顯示包、類、介面等的關係
GENERATE TREEVIEW      ＝ ALL
 
3、程式註釋文件化
使用Doxygen，需要按照Doxygen 的遊戲規則來對程式原始碼進行文件化。
Doxygen 的註釋型別可分為：
1、行間注釋：注釋語句不與程式原始碼出現在同一行，主要用於注釋標頭檔案中出現的結構體 (struct)、列舉 (enum)、聯合 (uion) 等資料型別，以及程式介面的功能與使用約定；
2、行內注釋：注釋語句與程式原始碼出現在同一行內，主要用於程式碼的區域性注釋。
詳細語法參考：http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
 
4、文件生成
cd test/
doxygen
提示：
可以指定組態檔名：doxygen  your-cfg-filename

 
5、文件使用
生成的文件位於test/doc/html 目錄中，使用瀏覽器開啟該目錄中的 index.html 檔案，即可看到自己的工作成果。

 Ubuntu 12.04下使用Doxygen生成API文件 http://www.linuxidc.com/Linux/2013-06/86036.htm

本文永久更新連結地址：http://www.linuxidc.com/Linux/2015-04/116607.htm