Doxygen,仅文档验证
Doxygen, documentation verification only
一个 运行 doxygen 如何在 "verification" 模式下? (解析所有文档,并在配置时发出警告,但不生成输出文件)。
我尝试使用以下 doxygen 配置文件:
DOXYFILE_ENCODING = UTF-8
QUIET = YES
INHERIT_DOCS = YES
EXTRACT_STATIC = YES
EXTRACT_PRIVATE = NO
WARN_NO_PARAMDOC = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_FORMAT = $file($line): $text
GENERATE_HTML = NO
GENERATE_LATEX = NO
INPUT += MySource.cs
源文件:
/// <summary>
/// My namespace documentation
/// </summary>
namespace MyNamespace
{
/// <summary>
/// My class documentation
/// </summary>
public class MyClass
{
/// <summary>
/// My function documentation
/// </summary>
/// <param name="param">The parameter</param>
/// <returns>My return value</returns>
public bool MyFunction(string param)
{
return true;
}
}
}
这会生成以下警告:
warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
这有点令人失望,因为我想设置 WARN_AS_ERROR = YES
。但另外我还会收到其他错误,例如:
MyClass.cs(17):warning: parameters of member MyNamespace.MyClass.My
Function are not (all) documented
MyClass.cs(17):warning: return type of member MyNamespace.MyClass.M
yFunction is not documented
如果我设置 GENERATE_HTML = YES
但是我没有警告,所以文档本身没有问题。我做错了什么还是这是一个错误?
Doxygen 不仅仅用于检查文档是否完整。 doxygen 的目的是生成文档。生成完整文档时先出现一些错误/可以在生成文档时正确检查。
解决方法:将QUIET = YES
和WARN_LOGFILE
配置选项设置为一个文件,然后解析该文件的内容。警告
warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
没有打印到那个文件。
一个 运行 doxygen 如何在 "verification" 模式下? (解析所有文档,并在配置时发出警告,但不生成输出文件)。
我尝试使用以下 doxygen 配置文件:
DOXYFILE_ENCODING = UTF-8
QUIET = YES
INHERIT_DOCS = YES
EXTRACT_STATIC = YES
EXTRACT_PRIVATE = NO
WARN_NO_PARAMDOC = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_FORMAT = $file($line): $text
GENERATE_HTML = NO
GENERATE_LATEX = NO
INPUT += MySource.cs
源文件:
/// <summary>
/// My namespace documentation
/// </summary>
namespace MyNamespace
{
/// <summary>
/// My class documentation
/// </summary>
public class MyClass
{
/// <summary>
/// My function documentation
/// </summary>
/// <param name="param">The parameter</param>
/// <returns>My return value</returns>
public bool MyFunction(string param)
{
return true;
}
}
}
这会生成以下警告:
warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
这有点令人失望,因为我想设置 WARN_AS_ERROR = YES
。但另外我还会收到其他错误,例如:
MyClass.cs(17):warning: parameters of member MyNamespace.MyClass.My
Function are not (all) documented
MyClass.cs(17):warning: return type of member MyNamespace.MyClass.M
yFunction is not documented
如果我设置 GENERATE_HTML = YES
但是我没有警告,所以文档本身没有问题。我做错了什么还是这是一个错误?
Doxygen 不仅仅用于检查文档是否完整。 doxygen 的目的是生成文档。生成完整文档时先出现一些错误/可以在生成文档时正确检查。
解决方法:将QUIET = YES
和WARN_LOGFILE
配置选项设置为一个文件,然后解析该文件的内容。警告
warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
没有打印到那个文件。