Doxygen, только проверка документов - PullRequest
Новая
       7

Doxygen, только проверка документов

0 голосов
/ 06 мая 2018

Как запустить 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, но у меня нет предупреждений, поэтому с документацией все в порядке. Я что-то не так делаю или это ошибка?

1 Ответ

0 голосов
/ 06 мая 2018

Doxygen не предназначен для проверки того, является ли документация полной. Цель doxygen - генерировать документацию. Некоторые ошибки сначала появляются при создании полной документации / могут быть надлежащим образом проверены при создании документации.

...