如何引用其他doxygen注释以避免重复
我正在编写一个接口文档,这个接口在IDL中描述。在这个界面中,我试图使用doxygen生成文档 我正在寻找一种在多个地方“重复”doxygen文档的方法 比如说如何引用其他doxygen注释以避免重复,doxygen,idl,Doxygen,Idl,我正在编写一个接口文档,这个接口在IDL中描述。在这个界面中,我试图使用doxygen生成文档 我正在寻找一种在多个地方“重复”doxygen文档的方法 比如说 struct StructA { long identifierA; ///< Some description about this identifierA long identifierB; ///< Some other description about this identifierB
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;
}
struct结构
{
long identifera;//<关于这个identifera的一些描述
long identifierB;//<有关此identifierB的其他说明
数据类型;
SomeTypeB数据库;
}
结构
{
long identifierA;//此成员的文档应与StructA::identifierA相同
long identifierB;//此成员的文档化方式应与StructA::identifierB相同
SomeTypeC-dataC;
}
在本例中,假设两个数据结构中的identifierA
和identifierB
表示相同的内容,例如,索引/标识数据的某种方式(例如,键)
Q:如果我在StructA
中描述标识符,我如何重复StructB
中标识符的文档?显然,我可以复制和粘贴,但如果我需要更改文档,这将带来麻烦。似乎应该有一种方法可以在一个地方引用文档,而不是在StructA
或StructB
之外的其他地方
或者我对这个文档的想法是错误的?struct-StructB
struct StructB
{
long identifierA; ///< @copydoc StructA::identifierA
long identifierB; ///< @copydoc StructA::identifierB
SomeTypeC dataC;
}
{
长标识符;//<@copydoc StructA::identifierA
long identifierB;//<@copydoc StructA::identifierB
SomeTypeC-dataC;
}
您是否查看过例如。\copydoc StructA::identifierA@albert啊,太好了。我错过了这个。我想这很管用。回答吧!