Как заставить Doxygen показывать предупреждения о недокументированном коде?C++

Программы на C++. Форум разработчиков
Ответить
Anonymous
 Как заставить Doxygen показывать предупреждения о недокументированном коде?

Сообщение Anonymous »

Среда
  • Windows 11
  • Doxygen 1.15.0
  • Команда: doxygen Doxyfile
Цель

Сбой сборки, если что-то недокументировано. Я ожидаю предупреждения (а также WARN_AS_ERROR=YES, ошибки) для недокументированных функций, пространств имен и т. д.
Минимальные файлы примеров
Заголовок

Код: Выделить всё

#pragma once
namespace spk
{
int firstFunction();
}
Источник

Код: Выделить всё

#include "header.hpp"
namespace spk
{
int firstFunction()
{
return 0;
}
}
Конфигурация Doxygen

Код: Выделить всё

PROJECT_NAME           = "UnnamedLibrary"
OUTPUT_DIRECTORY       = docs/build

INPUT                  = ./includes ./srcs
FILE_PATTERNS          = *.hpp *.cpp
RECURSIVE              = YES

EXTRACT_ALL            = NO
HIDE_UNDOC_NAMESPACES  = NO

WARNINGS               = YES
WARN_AS_ERROR          = YES
Команда Doxygen
Я просто вызываю doxygen Doxyfile в корне моего проекта, где находится Doxyfile
Соблюдается
Запуск doxygen завершается без предупреждений и ошибок. HTML генерируется. Функция недокументирована, но ничего не сообщается.
Ожидается
Предупреждения (или ошибки) о недокументированном spk::firstFunction() и пространстве имен spk.
Что-то вроде «ошибка: член firstFunction() (функция) пространства имен spk не документирован». например
Дополнительное примечание
Я заметил, что если я вставлю комментарий @file в начале хотя бы одного файла, doxygen, похоже, согласится вести себя так, как описано в разделе «Ожидаемые». Если вместо @file я добавлю любой другой тип комментария, например @class или @brief, doxygen вернется к поведению, описанному в разделе «Наблюдаемые».

Подробнее здесь: https://stackoverflow.com/questions/798 ... ented-code
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «C++»