Функции C документа Doxygen в проектах Objective-C

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

BOOL myFunc(void);

Который я затем реализовал в .m.

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


objective-c documentation doxygen
person Justin Meiners    schedule 07.09.2010    source источник

Ответы (1)


arrow_upward
2
arrow_downward

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

После дополнительного тестирования

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

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

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

Вы должны увидеть функции в разделе "Файлы - члены файла", как здесь в документах VTK.

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

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

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

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

person Andy Dent    schedule 10.09.2010
comment
Нет, это определенно обрабатывается. В нем перечислены файлы. И я попробовал твою штуку с @file, не помогло. При работе под Objective C придерживается ли он только методов и избегает функций c? - person Justin Meiners; 11.09.2010
comment
Хорошо, это сработало лучше, теперь они перечислены все, что здорово, но все еще не документируются с комментариями. - person Justin Meiners; 11.09.2010
comment
NVM Я исправил это большое спасибо! (Я дам тебе награду, как только смогу) - person Justin Meiners; 11.09.2010
comment
Я обнаружил, что установка EXTRACT_ALL не исправила для меня, НО установка SHOW_FILES = YES исправляет это. - person Pete; 25.08.2016