Ubuntu12.04下使用doxygen產生API文檔

     前段時間公司裡做項目要求遵循doxygen文檔規範，並且在Windows XP下安裝了Doxygen 1.8.4版本，使用起來能查看標頭檔是否遵循doxygen規範和一些簡單的錯誤，另外還可以根據C或者C++原始碼產生對應的API文檔，尤其是產生html格式的話就更方便了。

    比如說想尋找dbus、glib等原始碼的相關API文檔，可以使用doxygen工具將下載的開源軟體的原始碼產生對應的API文檔。

   doxygen也有linux的開源版本，如下：http://sourceforge.net/projects/doxygen/

   doxygen的網址：http://www.stack.nl/~dimitri/doxygen/index.html

                                  

http://www.doxygen.org/

   Doxygen Manual :http://www.stack.nl/~dimitri/doxygen/manual/index.html

   Documenting the code :
http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#docstructure

    如果看不慣英文，暫時可以參考一下百度百科關於doxygen的介紹：http://baike.baidu.com/view/1502693.html

   Doxygen是一種開源跨平台的，以類似JavaDoc風格描述的文檔系統，完全支援C、C++、Java、Objective-C和IDL語言，部分支援PHP、C#。注釋的文法與Qt-Doc、KDoc和JavaDoc相容。Doxgen可以從一套歸檔源檔案開始，產生HTML格式的線上類瀏覽器，或離線的LATEX、RTF參考手冊。

一、在Ubuntu12.04下使用apt-get install命令即可安裝doxygen命令列工具和相應的GUI工具，命令如下：

sudo apt-get install doxygen

sudo apt-get install doxygen-gui

安裝之後在/usr/bin目錄下有關於doxygen的三個命令工具：

doxygen(命令列工具)

doxytag

doxywizard(GUI嚮導工具)

二、在Ubuntu12.04下使用doxygen將下載好的原始碼產生API文檔。
1、以從blfs網站http://www.linuxfromscratch.org/blfs/view/svn/general/dbus.html下載原始碼D-Bus-1.6.10，連結為：http://dbus.freedesktop.org/releases/dbus/dbus-1.6.10.tar.gz，這個網站有很多現成的linux常用軟體。

2、Ctrl+Alt+T開啟終端，輸入doxywizard,會彈出如下的doxygen GUI介面，這個使用起來和Windows XP下使用的doxygen差不多。

2、將剛下載的dbus-1.6.10.tar.gz解壓縮

進入dbus-1.6.10.tar.gz下載所在目錄，使用如下命令解壓：

tar -xzvf dbus-1.6.10.tar.gz

或者選擇dbus-1.6.10.tar.gz點擊右鍵，選擇【Extract here】即可。

3、配置dbus工程的選項，例如：doxygen指令碼設定檔存放路徑、doxygen API文檔存放路徑、工程名、版本號碼等資訊。

在工作目錄，例如/home/ccf/Downloads下建立tmp目錄存放doxygen指令碼設定檔，建立dbus-html-docs目錄用於存放輸出的dbus API文檔，另外將解壓縮後的dbus-1.6.10原始碼也移動到此目錄下，在第1步彈出的doxygen gui介面中進行如下配置：

從上面的配置可以看出：

doxygen API配置指令碼存放路徑為：/home/ccf/Downloads/tmp

工程名稱為：dbus

版本號碼為：1.6.10

原始碼所在目錄為：/home/ccf/Downloads/dbus-1.6.10

doxygen API文檔輸出路徑：/home/ccf/Downloads/dbus-html-docs

另外，注意上面的【Scan recursively】單選框一定要選上，否則產生不了對應的doxygen API文檔。

4、回合組態指令碼，產生doxygen文檔

選擇run tab頁，然後單擊Run doxygen 按鈕產生doxygen API文檔,如所示：

5、查看產生的 dbus API文檔參考手冊，

可以直接單擊第4步Run doxygen Tab頁的【Show HTML output】按鈕，查看dbus API html格式的文檔。

或者直接進入dbus API文檔結果輸出目錄，進入html目錄下，即/home/ccf/Downloads/dbus-html-docs/html/，找到index.html並雙擊開啟，如下所示：

可以看到有關dbus API的資訊，dbus的介紹、模組、類、檔案等說明。

這個還有一個Doxywizard命令工具的Mac GUI使用說明，可以對照著Ubuntu12.04看一下，發現Windows下、Ubuntu12.04下、Mac下的Doxygen工具介面都差不多，使用上也大同小異，網址為：http://www.stack.nl/~dimitri/doxygen/manual/doxywizard_usage.html

以後下載原始碼，如果找不到官方的說明文檔，或者說網上介紹得不夠詳細，可以使用doxygen產生相應的API參考手冊，不過前提最好是寫的文檔符合doxygen代碼規範哦！