使用 "\return" 作为 "\brief"

Use "\return" as "\brief"

对于非常简单的功能,我希望只有一个 \return 部分,但仍将其显示为简短。 (如何)这可以做到吗?

例如:

/**
\return The distance.
*/
template <typename R = int64_t>
R distance(const pcg32 &other);

这不会在文档中生成 \brief,而例如这样做:

/**
Multi-step advance function (jump-ahead, jump-back).
\param distance the distance.
*/
template <typename T>
void advance(T distance);

查看此屏幕截图:

我认为 brief 部分是用来保存单个段落的,而 \return 命令实际上会生成一个 header 和一个段落。

为了避免更改任何全局 REPEAT_BRIEF 设置,我建议在这种情况下使用一个简单的宏,例如

  • 将以下内容添加到 doxygen ALIASES 配置中:
    "briefreturn=**Returns** "
  • 像这样在您的描述评论中使用:
/** \briefreturn the value that it returns */
int foo();

这将为您提供一个 one-line 摘要,类似于 \return 的 multi-line 输出。

修改宏,您可以根据需要实现其他行为,例如,强制生成 details 部分,即使没有提供其他详细信息但 return:

"briefreturn{1}=**Returns**  \details. "

这还是可以正常跟进细节的。不过请注意,它将有一个前导“.”。 (也许可以使用其他一些 non-whitespace 字符作为前导字符,而不是令人反感的字符)