Doxygen,仅用于文件验证
如何在“验证”模式下运行doxygen?(解析所有文档,并在配置时发出警告,但不生成输出文件) 我尝试使用以下doxygen配置文件:Doxygen,仅用于文件验证,doxygen,Doxygen,如何在“验证”模式下运行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_FORM
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;
}
}
}
这有点令人不快,因为我想将WARN\u设置为\u 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\u HTML=YES
,但是我没有警告,因此文档本身就可以了。我是做错了什么还是这是一个bug?Doxygen并不是为了检查文档是否完整。doxygen的目的是生成文档。生成完整文档时首先出现一些错误/生成文档时可以正确检查这些错误。好的,谢谢,似乎我必须选择最快的输出。(我在build上运行doxygen是为了在早期捕获文档错误,但当使用许多项目时,额外的构建时间可能会相当快地累积起来)对于其他面临类似场景的人,也可以看看在使用“GENERATE_XML=YES”(或RTF)时仍然会收到关于参数和返回类型的相同警告,使用GENERATE_HTML=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