English 中文(简体)
显示无证功能参数
原标题:Show undocumented function parameters
  • 时间:2012-05-04 09:21:16
  •  标签:
  • doxygen

I m 采用氧气生成C++代码的超文本文件。 遗憾的是, d氧并没有在方法描述中显示无证方法参数。 例如:

/**
 * Some method
 * @param p1 Some param
 */
void method(const std::string& p1, const std::string& p2);

the method description will show the comment and the parameter p1 but not p2.

我怎么会把所有参数列入方法描述,即使没有明确记载?

最佳回答

这是不可能的。

氧气可以警告你,光是不完整的、错误的或缺失的参数文件。

The relevant settings are:

WARNINGS          = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC  = YES
问题回答

暂无回答




相关问题
Is there a standard for documenting GET/POST parameters?

In a PHP project, even when front controller logic is used for the main application, there can be many stand-alone scripts, ajax snippets and so on. Is there a standardized way - either PHPDoc or ...

How to use eclox, the doxygen plugin for Eclipse

How do I get eclox working in Eclipse 3.5? I m using Ubuntu 9.04. I installed Doxygen from ubuntu repositories(version 1.5.8). Then I installed eclox on eclipse through the update site. Despite this,...

Doxyclean Error

I m trying to run doxyclean but can t get it to work, any help would be appreciated... I m running from terminal : ./doxyclean.py --input=./xml/ --output=./clean/ --name="MyProject" --phone -v I ...

Doxygen and Objective-C categories

Although the latest releases of Doxygen claim better handling of Objective-C categories, it still seems to choke on categories in my source code. I m wondering if someone has gotten it to document ...

Algorithm to parse a config file in php (Doxygen file)

I have a conf file like this: http://pastie.org/768582 and my goal is to get in an array the comments and the key/value of each keys. array( array( comment => "The PROJECT_NAME tag is a ...

热门标签