Appledoc и описание пользовательской ссылки

Если я делаю что-то глупое, заранее извиняюсь. Но я не могу определить свою ошибку.

Вот код (заголовочный файл):

#import <Foundation/Foundation.h>

/**
 Represents a cover image. It can be a game cover, a trophy image or even a player avatar.

 It has three properties:

 - **NSMutableString uri**: the link that points to the image.
  - E.g.: [A Skyrim trophy image URI] (http://bit.ly/skyrimTrophyImageUri ).

 - **UIImage img**: the actual image. That is, the bitmap.
  - E.g.: 1A9A3826FB6B42C1B08824655A740620BC8E75F9.PNG

 - **ResolutionType resolution**: the image resolution, which comes from an enumeration of this class called __"ResolutionType"__.
  - E.g: SEN_75x41

*/

@interface NHOCCover : NSObject

Результат:

Я следую этим инструкциям (в разделе "Пользовательские ссылки").

Я также попробовал:

Может быть, Xcode портит файл? На второй связанный вопрос, знаете ли вы, есть ли способ заблокировать Xcode от автоматического создания ссылок в его редакторе? (Я имею в виду изменить цвет шрифта на синий и подчеркнуть его).

Заранее спасибо.

2 ответа

Решение

Уже ответил вам на github, добавив здесь ответ и для людей, заходящих на эту страницу: это известная проблема с v2, будет исправлена ​​в 3.0. См. https://github.com/tomaz/appledoc/issues/180

/**
 Represents a cover image. It can be a game cover, a trophy image or even a player avatar.

 It has three properties:

 - **NSMutableString uri**: the link that points to the image.
  - E.g.: [A Skyrim trophy image URI] (http://bit.ly/skyrimTrophyImageUri ).

 - **UIImage img**: the actual image. That is, the bitmap.
  - E.g.: 1A9A3826FB6B42C1B08824655A740620BC8E75F9.PNG

 - **ResolutionType resolution**: the image resolution, which comes from an enumeration of this class called __"ResolutionType"__.
  - E.g: SEN_75x41

*/

В вашем коде есть пробел между [URI трофейного изображения Skyrim] и ( http://bit.ly/skyrimTrophyImageUri), я думаю, что пробел вызывает проблему.

Правильный формат

[A Skyrim trophy image URI](http://bit.ly/skyrimTrophyImageUri )

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

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