Doxygen省略了默认参数值

时间:2016-03-09 14:34:46

标签: c++ doxygen

我正在使用Doxygen记录我的C ++代码,并决定只在实现文件中(在函数定义之上)这样做,以便头文件(函数声明)保持较小。

部首:

std::string color_to_hex( 
    const Color& c, 
    std::string prefix = "#", 
    bool uppercase = false 
);

实现:

/**
 * @brief ...
 */
std::string color_to_hex(
    const Color& c, 
    std::string prefix, 
    bool uppercase
) {
    // ...
}

现在,在Doxygen生成的文档中,参数("#"false)的默认值不会出现。

我试过了:

  • 使用@param标记。不起作用,不会出现默认参数值。
  • 将doc-block移动到声明中。工作,但如上所述,不是我想要的。
  • 在声明(/** */)中添加一个最小的doc-block。没有任何事情发生。
  • 在标题中添加其他(不同的)doc-block。正如所料,文档现在包含两个文本,但不显示默认值。
  • 将相同的doc-block添加到声明中。 Doxygen很聪明,可以实现这一点,只输出一次文本。但是,没有默认的参数值。

有关如何使其发挥作用的任何想法?

0 个答案:

没有答案