如何引用其他doxygen註釋以避免重複您自己

Question

我正在處理IDL中描述的接口文檔。在這個界面中，我試圖使用doxygen來生成文檔。

我正在尋找一種方法在多個地方「重複」doxygen文檔。

例如

struct StructA 
{ 
    long identifierA; ///< Some description about this identifierA 
    long identifierB; ///< Some other description about this identifierB 
    SomeTypeA dataA; 
    SomeTypeB dataB; 
} 
struct StructB 
{ 
    long identifierA; // This member should be documented the same as StructA::identifierA 
    long identifierB; // This member should be documented the same as StructA::identifierB 
    SomeTypeC dataC; 
} 

在這個例子中，假設在兩個數據結構identifierA和identifierB表示相同的事情，例如，索引的一些方法/識別數據（例如，密鑰）。

問：如果我在StructA中描述標識符，如何重複StructB中標識符的文檔？很明顯，我可以複製和粘貼，但如果我需要更改文檔，這將會令人頭疼。似乎應該有一種方法可以在除StructA或StructB之外的某個地方參考文檔。

或者我正在考慮以錯誤的方式處理這個文檔？

Answer 1

struct StructB 
{ 
    long identifierA; ///< @copydoc StructA::identifierA 
    long identifierB; ///< @copydoc StructA::identifierB 
    SomeTypeC dataC; 
}