Question

假设您有以下方法docstring + declaration：

/**\brief What it does
 * \param[in] a docstring for a
 * \param[in] b same docstring as in a
 */
void fun(
    const int& a
    const int& b
    int* c
)

有没有办法让a和b函数参数具有相同的文档字符串而不重复它？

我尝试用\{ ... \}语法包装它们，就像在具有相同文档字符串的函数中一样，但它似乎不起作用。

提前致谢，

Answer 1

如果要通过相同的docstring描述一个或多个参数，可以将它们指定为以逗号分隔的列表。在你的情况下，

/**\brief What it does
 * \param[in] a,b some common description
 */
void fun(
    const int& a
    const int& b
    int* c
)

Doxygen - 多个方法参数的相同docstring

1 个答案: