Linux Doxygen的安裝與使用__Linux

1、安裝
yum -y install doxygen*


2、使用
（1）在工程目錄下輸入doxygen -s -g doxyconfig，其中doxyconfig為組建組態的檔案名稱，可任意指定，如果不指定，預設產生的設定檔為Doxyfile。
（2）設定檔
    DOXYFILE_ENCODING = UTF-8，預設編碼為UTF-8，這樣可以支援中文。
    PROJECT_NAME = “xxxx”，項目名稱，多個單詞需要使用引號(“”)。
    PROJECT_NUMBER = “1.0 beta”，項目版本號碼。
    OUTPUT_DIRECTORY = Doc，輸出文檔的目錄，如果為空白，表示在目前的目錄，建議寫上表示本工程的有意義的目錄名稱。
    OUTPUT_LANGUAGE = English，文檔語言，可以指定為Chinese。
    IMAGE_PATH = image_dir，指定圖片存放的目錄，我們將圖片放到目前的目錄下的image_dir目錄中，因為我們的文檔會出現測試圖片樣本。
    HTML_OUTPUT= . ，html輸出目錄名稱，預設為html目錄，如果為“.”則表明為上述OUTPUT_DIRECTORY目錄。
    GENERATE_LATEX = NO，是否產生LaTeX，預設產生的，但我們不想產生。

    INPUT = xxx，代碼檔案或目錄，多個檔案(目錄)需要以空格隔開，如果不指定，表示目前的目錄，但是，如果指定目錄且目前的目錄有代碼檔案的話，需要使用點號(“.”).表示目前的目錄。

    FILE_PATTERNS = *.c *.cpp *.h *.hpp，指定各種檔案，我們常用為*.cpp *.c *.h，等等。

    EXTRACT_PRIVATE = YES，顯示類的私人成員變數和函數。 （3）產生文檔 doxygen


3、參考注釋風格
/**
* @file BinaryHeap.hpp
* @brief 二元堆積
* 
* @author xiao2 joyjj0218@qq.com 
* @version 1.0 
* @date 2015.11.17 
*/

#ifndef BINARYHEAP_HPP_
#define BINARYHEAP_HPP_

#include <vector>
#include <algorithm>


using namespace std;


/**
* @brief 演算法
*/
namespace algorithm
{
/**
* @brief 二元堆積
*/
template <typename comparable>
class BinaryHeap
{
public:
explicit BinaryHeap(vector<comparable> &item) :
m_vecArray(item), m_iSize(m_vecArray.size())
{
}

public:
void BuildHeap(int current_size)
{
for(int i = current_size / 2 - 1 ; i >= 0; i--)
PercolateDown(i, current_size);
}

void HeapSort()
{
for(int i = m_iSize; i > 0; i--) {
BuildHeap(i);
swap(m_vecArray[0], m_vecArray[i-1]);
}
}

private:
/**
* @brief 滲透下沉
* @param[in] current 當前下沉位置
* @param[in] current_size 當前下沉序列大小
* @return void.
*/
void PercolateDown(int current, int current_size)
{
int parent;
int child;

parent = current;
comparable temp = m_vecArray[current];

for( ; (2 * parent + 1) < current_size; ) {
child = 2 * parent + 1;

if(child < current_size - 1 && m_vecArray[child+1] < m_vecArray[child])
child++;

if(m_vecArray[child] < temp) {
m_vecArray[parent] = m_vecArray[child];
parent = child;
} else {
break;
}
}
m_vecArray[parent] = temp;
}

private:
vector<comparable> &m_vecArray;  ///< 輸入vector數組的引用
int m_iSize;  ///< vector數組的大小
};
}


#endif  // BINARYHEAP_HPP_