如何避免在 doxygen 评论中重复自己（不幸的是没有成员组）？

Question

我正在用 doxygen 注释记录我的（C++）库。

在这个库中，我有一些相同函数重载的情况，执行相同的操作但使用不同的输入，例如

void frobincate(char const* s, int x, bool b);
void frobincate(char const* s, float f, double d);

我注意到 Doxygen 有组开始和结束命令，

///@{

和

///@}

，所以我天真地写道：

/// @brief Perform frobnication
/// @param s just some string

///@{

/// @param x a xylophonic calue
/// @param b a bulwark of a value
void frobincate(char const* s, int x, bool b);

/// @param f a fantastic value
/// @param d a dastardly value
void frobincate(char const* s, float f, double d);

///@}

但是，查看 doxygen 此类分组的文档 和 生成的输出示例，我指定的组级命令似乎不适用于 any 组成员 - 仅适用于组级文档。而且，事实上，我不想特别关注

frobnicate()

- 它只是一个具有多个可能的输入参数类型组合的函数。

有没有办法让我不重复自己的话？一方面是函数文档，但另一方面该文档文本是否应用于实际函数？或者我必须诉诸复制和粘贴吗？

Answer 1

_{（感谢@albert指出这一点）}

您可以使用

@copydoc

命令 将

@brief

和

@details

文档内容从第一个记录项目复制到第二个及后续项目。即使您引用多个同名函数的一个变体，这也应该有效。

如果这样做，您就可以摆脱分组。

不幸的是，这目前不会复制

@param

文档。