【问题标题】:Doxygen, documentation verification onlyDoxygen,仅文件验证
【发布时间】: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


    【解决方案1】:

    Doxygen 不仅仅用于检查文档是否完整。 doxygen 的目的是生成文档。生成完整文档时首先出现一些错误/生成文档时可以正确检查。

    【讨论】:

    • 好的,谢谢,看来我必须选择最快的输出。 (我在构建时运行 doxygen 以尽早捕获文档错误,但是当使用许多项目时,额外的构建时间会很快增加)
    • 其他遇到类似情况的朋友,也可以看看stackoverflow.com/questions/8247189/doxygen-is-slow
    • 在使用“GENERATE_XML = YES”(或 RTF)时,仍然会收到关于参数和返回类型的相同警告,但在使用 GENERATE_HTML = YES 时没有警告。所以警告似乎取决于输出类型?
    • 你的调查有进展了吗?
    • 不幸的是,我还没有时间深入研究它。它仍在我的名单上,不是那么短。
    【解决方案2】:

    解决方法:将QUIET = YESWARN_LOGFILE 配置选项设置为一个文件,然后解析该文件的内容。警告

    warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
    

    没有打印到那个文件。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2020-11-23
      • 1970-01-01
      • 1970-01-01
      • 2012-03-18
      • 1970-01-01
      • 2018-12-01
      • 2017-07-02
      相关资源
      最近更新 更多