Получите Doxygen, чтобы показать ошибки компиляции XCode, если документация отсутствует

В прошлом мне это удавалось, но теперь я не могу найти параметр, который сообщает XCode или Doxygen (или обоим) отображать ошибки компиляции, если документация отсутствует. Я просмотрел документацию Apple, в которой рассказывается, как создавать наборы документов, и она отлично работает, но XCode не выдает ошибок компиляции при отсутствующих комментариях в исходном коде. Кто-нибудь знает, как это включить?

Спасибо, Роб


person Rob    schedule 31.05.2010    source источник


Ответы (1)


Чтобы заставить Doxygen генерировать ошибку при отсутствии документации, у вас есть следующие варианты:

  • ПРЕДУПРЕЖДЕНИЯ
  • WARN_IF_UNDOCUMENTED
  • WARN_IF_DOC_ERROR
  • WARN_NO_PARAMDOC

В XCode вы можете запустить Doxygen с фазой сборки Run Script. В «Результатах сборки» каждая строка, начинающаяся с «Предупреждение:», будет выделена в Xcode.

person Laurent Etiemble    schedule 01.06.2010
comment
Спасибо за ответ. У меня были отмечены ПРЕДУПРЕЖДЕНИЯ, WARN_IF_UNDOCUMENTED и WARN_IF_DOC_ERROR. Но у меня не было файла WARN_NO_PARAMDOC. У меня уже есть сценарий запуска для моей основной цели. Я внес изменения и попробовал еще раз. Он по-прежнему не помечал пропущенные комментарии. Любые другие идеи? - person Rob; 01.06.2010
comment
Вы видели вывод вызова doxygen в результатах сборки? Возможно, у вас не установлен фильтр вывода только для ошибок и предупреждений. - person Laurent Etiemble; 01.06.2010
comment
Да, вывод doxygen был в результатах сборки. Я проверил документацию (HTML), и она обновлена. Сценарий запуска, похоже, работает должным образом, но почему-то кажется, что XCode не получает предупреждения/ошибки. - person Rob; 02.06.2010