Doxygen：在函數內移動靜態變量文檔

Question

考慮這個代碼：

#include <string>

namespace MyNamespace
{

/** \brief Error Class */
class Error
{
public :
    /** \brief Constructor */
    Error ( int in_code, const std::string& in_message );
    ...
};

/** \brief Successfull result */
static Error SUCCESS(                                   0, "Success. " );
/** \brief Error of unknown kind, used internally only to identify a pending result */
static Error ERROR_UNKNOWN(                             1, "Unknown Error. " );
...

};

MyNameSpace 已經是 doxygen 組的一部分。 當我生成文檔時，我得到：

• 一頁Error類描述
• SUCCESS和ERROR_UNKNOWN是MyNamespace頁面中的“函數”（奇怪！）

如何標記SUCCESS和ERROR_UNKNOWN以顯示在Error類描述頁面中？

注意：我無法定義一個新組並將兩者都放入，因為我的組列表已凍結（我們希望每個庫一個組）。 “隱藏”組可能是解決方案。

Answer 1

到目前為止，我能找到的最好的“解決方案”是使用\\memberof 。

這個：

/** \memberof Error @{ */

/** \brief Successfull result */
static Error SUCCESS(                                   0, "Success. " );
/** \brief Error of unknown kind, used internally only to identify a pending result */
static Error ERROR_UNKNOWN(                             1, "Unknown Error. " );
...

/** @} */

將Error類描述的“靜態公共成員函數”下的SUCCESS和ERROR_UNKNOWN移動。 這不是很好，因為它們然后與其他真正的靜態公共成員函數混合。 但也添加了一個\\name標簽......

/** \memberof Error @{ */
/** \name Error values: */

/** \brief Successfull result */
static Error SUCCESS(                                   0, "Success. " );
/** \brief Error of unknown kind, used internally only to identify a pending result */
static Error ERROR_UNKNOWN(                             1, "Unknown Error. " );
...

/** @} */

將在Error類描述的“相關函數”下的“錯誤值”部分中移動SUCCESS和ERROR_UNKNOWN ，並帶有一個很好的注釋報告(Note that these are not member functions.) ......這絕對是可以接受的......

Answer 2

在代碼中， SUCCESS和ERROR_UNKNOWN不是Error類的一部分，因此生成的文檔是正確的（撇開“函數”的問題）。

試圖讓 doxygen 將它們顯示為 Error 類的一部分是非常具有誤導性的，因為文檔和代碼現在是矛盾的。

如果您真的希望SUCCESS成為Error類的一部分，請在代碼中做到這一點。

或者，這可能是意圖，在Error類的文檔中，添加類似@see SUCCESS 、 @see ERROR_UNKNOWN 。

這將生成指向這些項目文檔的“另請參閱”注釋。