的Doxygen - 文檔結構變量而不是結構

Question

比方說，我有這樣的結構類型：

typedef struct Hidden Hidden; 
struct Hidden 
{ 
    int foo; 
    int bar; 
}; 

，然後我有一個全局變量

Hidden visible; 

Hidden不應該被用來和visible應成爲Hidden類型的唯一聲明。我不想爲Hidden生成文檔，因爲我不希望它被使用，而是生成關於visible的文檔以及關於它的所有信息及其字段。

我發現的最接近的是，當你有沒有像標籤記錄一個struct：

struct 
{ 
    int foo; ///< Number of particals in the universe. 
    int bar; ///< Number of socks in the drawer. 
} Baz; ///< Nameless struct variable. 

的Doxygen將產生

struct { 
    int foo 
     Number of particals in the universe. 
    int bar 
     Number of socks in the drawer. 
} Baz 
    Nameless struct variable. 

這是我想要的那種東西實現，但我不能使用無名的結構。

這樣的事情可能嗎？

Answer 1

我找到了一種方法來做到這一點。建議使用proprocessor預定義，因爲建議使用@RBE，您可以僅爲不會編譯的doxygen創建代碼。因此，只要做到這一點（並DOXYGEN預定義宏）：

typedef struct Hidden Hidden; 

#ifdef DOXYGEN 

struct 
{ 
    int foo; ///< Number of particals in the universe. 
    int bar; ///< Number of socks in the drawer. 
} visible; ///< Nameless struct variable! 

#endif 

struct Hidden 
{ 
    int foo; 
    int bar; 
}; 

Hidden visible; 

這是哈克，但它的作品。

Answer 2

做你想要什麼，最簡單的方法是使用宏定義，你會編譯代碼之間切換，並且你的代碼將在運行doxygen的：

#define DOXYGEN 

#ifdef DOXYGEN 
/** 
* @brief Describe your visible structure here. 
*/ 
typedef struct VISIBLE 
{ 
    int foo; //< Number of particles in the universe. 
    int bar; //< Number of socks in the drawer. 
} VISIBLE; 
#else 
typedef struct HIDDEN 
{ 
    int foo; 
    int bar; 
} HIDDEN; 

HIDDEN visible; 
#endif 

簡單的評論或取消對DOXYGEN定義從一個切換到另一個。

Answer 3

您是否考慮過在沒有typedef的情況下聲明struct類型？例如，這可能工作：

/** 
* @brief This is a variable that is the only instance of a structure of its kind. 
*/ 
struct Hidden 
{ 
    int foo; ///< Docs 
    int bar; ///< Docs 
} visible; 

您也可以嘗試申報外記錄，如Use doxygen to document members of a c structure outside of the structure definition