Поддерживает ли doxygen встроенные комментарии для аргументов метода в Objective-C? - PullRequest
4 голосов
/ 16 февраля 2009

Раньше я использовал партию Doxygen для C ++, и мне действительно нравилась возможность документировать аргументы функций и методов, используя ///< или их варианты. И наоборот, мне действительно не нравится необходимость повторять аргументы в комментариях, когда не используется встроенный стиль (поскольку большинство систем с кодовым документом поддерживают только).

Так что недавно я настраивал doxygen с помощью своего кода Objective-C и не могу заставить работать документирование встроенных аргументов!

Кажется, что работает внеплановое документирование с использованием @param - поэтому я могу только заключить, что он не поддерживает встроенный синтаксис метода Objective-C. Это было бы настоящим позором.

Кто-нибудь знает что-то другое? Я бы хотел, чтобы это сработало.

Ответы [ 2 ]

2 голосов
/ 24 февраля 2009

Вы пробовали синтаксис, упомянутый в руководстве:

void foo(int v /**< [in] docs for input parameter v. */);

Я проверил это, и у меня это сработало.

0 голосов
/ 16 февраля 2009

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

...