Question

如何在“验证”模式下运行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但是我没有警告，所以文档本身没问题。我做错了还是这个错误？

Answer 1

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

Doxygen，仅限文档验证

1 个答案: