5
我試圖記錄一些代碼,有很多重載的各種功能。這些功能以非常不同的方式做同樣的事情。重載函數文檔在Doxygen(C++)
我想使用Doxygen將所有這些功能記錄在一起,類似於在cppreference.com(example)中完成的方式。
是否有可能在Doxygen中獲得類似的行爲?如果是這樣,怎麼樣?
我試圖記錄一些代碼,有很多重載的各種功能。這些功能以非常不同的方式做同樣的事情。重載函數文檔在Doxygen(C++)
我想使用Doxygen將所有這些功能記錄在一起,類似於在cppreference.com(example)中完成的方式。
是否有可能在Doxygen中獲得類似的行爲?如果是這樣,怎麼樣?
有一個類似的問題: Grouping overloads in doxygen
我認爲,第一個答案,回答你的問題,因爲它會根據集團統一名稱的一組功能。我居然給它使用下面的頭一試:
#ifndef TEST_H
#define TEST_H
/**
* @brief Test Class
*/
class Test
{
public:
///Default Constructor
Test();
/**
* @name Overloaded methods
*/
//@{
///OverLoad1
void func1(void);
/**
* @brief Overload2
* @param a test variable
*/
void func1(int a);
//@}
};
#endif //TEST_H
如果產生與強力黴素文件,你會看到重載方法組合在一起的簡要說明。
我希望有幫助!
謝謝你。我認爲這是儘可能的接近。 – Zeenobit
cppreference不使用doxygen ... – Walter
@Walter我意識到這一點。我試圖看看我是否可以用Doxygen來模擬這種行爲。 :) – Zeenobit