Блог

Главная - Вопросы по программированию - Ссылка на ivar или методы с помощью Doxygen

Ссылка на ivar или методы с помощью Doxygen

#objective-c #doxygen

#objective-c #doxygen

Вопрос:

Я попытался, следуя документации Doxygen, добавить ссылки на ivar и методы, но ни один из них не интерпретируется Doxygen.

Это то, что я делаю.

 @interface MyClass: NSObject
{
  int x;
}
@end

Somewhere else:
/**
Trying to link to x.
MyClass::x
*/

РЕШЕНИЕ: ссылка на то, что не задокументировано, не создается. Просто добавил документацию в мой ivar, и ссылка была создана.

Комментарии:

1. Разве вы не должны использовать @interface вместо @class?

2. Извините, сообщение было исправлено. Это была ошибка при написании кода. Я не могу жить без автокоррекции!

Ответ №1:

Попробуйте следующее:

 /** Class documentation. */
@interface MyClass: NSObject
{
    /** This documentation is for x. */
    int x;
}
@end


/** @page mypage A page
    This is a ref MyClass::x "link" to x.
    This also links to x: MyClass::x.
 */

Комментарии:

1. Не было необходимости добавлять ref . Я указывал на ivar, который не был задокументирован, поэтому ссылка не была создана.