【发布时间】:2018-10-16 09:06:01
【问题描述】:
如何在“验证”模式下运行 doxygen? (解析所有文档,如果配置如此,则发出警告,但不生成输出文件)。
我尝试使用以下 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