Question

我正在拉扯我的C ++库并使用Doxygen编写一个很好的文档。假设我声明了类型：

typedef enum {
    NO_ERROR,                ///< Everything fine.
    SOME_REALLY_BAD_ERROR,   ///< Something went wrong.
    VERY_INFREQUENT_ERROR    ///< Used only in some cases.
} ReturnType;

并将其用作返回值以标记函数中的可能错误。现在我定义一个函数：

/** Very important description
 *
 * @return NO_ERROR on proper exit, SOME_REALLY_BAD_ERROR otherwise.
 */
ReturnType ImportantFunction();

因此，对于每个函数定义，我必须粘贴相同的默认返回值描述（但有时我会返回VERY_INFREQUENT_ERROR并写出不同的描述）。所以我的问题是：

在Doxygen中是否有办法创建返回值的默认描述，或者我应该为不常见的情况创建描述？

Answer 1

AFAIK您无法创建默认说明。你可以做的是使用\copydoc至少只写一次你的文字：

/**
 * \class common_ReturnType
 *
 * NO_ERROR on proper exit, SOME_REALLY_BAD_ERROR otherwise.
 */

/** Very important description
 *
 * @return \copydoc common_ReturnType
 */
ReturnType ImportantFunction();

/** Very important description with very infrequent result
 *
 * @return \copydoc common_ReturnType In very infrequent cases, VERY_INFREQUENT_ERROR.
 */
ReturnType ImportantFunctionWithInfrequentResult();

这将在您的common_ReturnType文档中生成一个虚拟条目。您可以使用配置文件中的EXCLUDE_SYMBOLS = common_*将其从输出中排除。

Answer 2

您可以使用确切的返回文档定义别名命令：

ALIASES += "return_noerr=@return NO_ERROR on proper exit, SOME_REALLY_BAD_ERROR otherwise."

然后你可以使用那个快捷方式：

/**
 * @return_noerr
 */

Doxygen中返回值的默认描述

2 个答案: