我正在研究记录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
之外的其他地方。
或许我正在以错误的方式思考这些文档?
答案 0 :(得分:2)
struct StructB
{
long identifierA; ///< @copydoc StructA::identifierA
long identifierB; ///< @copydoc StructA::identifierB
SomeTypeC dataC;
}