Документ Doxygen C работает в проектах Objective-C - PullRequest
Новая
       10

Документ Doxygen C работает в проектах Objective-C

4 голосов
/ 08 сентября 2010

Я программирую проект в Objective-C, и я начал использовать Doxygen для автоматического создания документации. Значительная часть проекта содержит основные функции C. К сожалению, Doxygen не документирует функции C, а только классы Objective-C и их методы. У меня есть функции, определенные в нескольких заголовочных файлах, например: 

BOOL myFunc(void);

Что я тогда реализовал в .m.

Doxygen не обнаруживает прямые функции C в Objective-C или есть опция, которую я должен включить? Моя функция неправильно определена для Doxygen?

1 Ответ

2 голосов
/ 10 сентября 2010

Doxygen определенно документирует прямые функции C.

После дополнительных испытаний

Используйте Doxywizard и проверьте значения в экспертном режиме - он предоставляет некоторую полезную помощь, когда вы наводите курсор мыши. В частности, вы должны были изменить значение по умолчанию, поэтому EXTRACT_ALL проверено

Я думаю, что необходимость установить это, в отличие от значения по умолчанию, возможно, является ошибкой.

Если отчаянно, опубликовать настройки в вопросе. Я только что создал образец с нуля и убедился, что ваша функция обнаруживается с использованием Doxygen, когда я использую EXTRACT_ALL, но в разделе «Члены файла» нет, если я отключаю это.

Функции «Файлы - члены файла» должны отображаться как здесь в документах VTK.

Извините, я не поднял его раньше, но у меня всегда включен EXTRACT_ALL, так как я работаю с устаревшими кодами, где большинству функций не нужны специальные комментарии.

более ранняя идея Попробуйте добавить комментарий @file вверху файла, чтобы увидеть, обрабатывается ли он. 

   /// @file fred.h This file defines functions used in fred.m

Могу поспорить, что ваше расширение или ваш каталог не включены в ваш установочный файл doxygen.

...