Ссылка на внешнюю документацию URL из комментариев Objective-C в стиле doxygen

Я хочу написать что-то похожее на это:

/**
 Post a review. (For every place belongs only one review. If it was already written, the previous one will be overwritten.)

 @param placeId Place identifier
 @param rating Rating 0-5 for the place
 @param review The text the user entered for review
 @param callback Gets called either when the network request succeeds or when fails for some reason. The `success` parameter indicates this. If success is true, the contents of the `data` parameter of the response is given back as the `response` parameter. If the request fails, then only the `error` parameter is filled. You can find the details in this object.

 @see http://example.com/api/v1/doc/service/review/saveReview?pkey=t75jg-5uGse-qIo
 */
- (void)saveReviewFor:(NSNumber *)placeId rating:(NSUInteger)rating review:(NSString *)review callback:(VMNetworkCallback)callback;

Проблема в том, что ссылка на @see тег не кликабелен в подсказках Xcode:

Скриншот Xcode

Можно ли иметь кликабельную ссылку на документацию в этом представлении? Какой синтаксис я должен использовать?

1 ответ

Да, это возможно. Измените свой @see тег должен быть следующим:

      @see <http://example.com/api/v1/doc/service/review/saveReview?pkey=t75jg-5uGse-qIo>

Для получения дополнительной информации вы можете прочитать соответствующий раздел в Doxygen DocumentationMarkdown support -&amp;gt; Automatic Linking.

Другие вопросы по тегам