Cross reference in XCode comments

Asked Jun 16 '14 at 06:49

Active Jun 16 '14 at 07:02

Viewed 441 times

what I'm trying to do is to create comment with link to another method for example like in Doxygen

/**
 * Some comment {@link method}
 */

But when I do this comment in XCode it does not show links to methods in right QuickHelp panel. Is there some quick explanation of how to do this or why I cannot do this?

I want to generate something like this, where in this example you can click CGImageRef or CIImage.

enter image description here

edited Jun 16 '14 at 07:02

asked Jun 16 '14 at 06:49

Majky

1,943
1
18
30

I don't believe link is supported. – trojanfoe Jun 16 '14 at 06:52
Is there any alternative that is supported? – Majky Jun 16 '14 at 06:53
Not to my knowledge. See this (very) informative SO question: http://stackoverflow.com/questions/19168423/what-are-the-new-documentation-commands-available-in-xcode-5 – trojanfoe Jun 16 '14 at 06:54
Thanks I'm looking at the link right now! There are methods with comments with links (see screenshot added) – Majky Jun 16 '14 at 07:03
And what does the related comment look like in `UIImage.h`? – trojanfoe Jun 16 '14 at 07:09
There is not such comment in UIImage.h :D – Majky Jun 16 '14 at 07:49
Exactly; Apple use appledoc to generate their documents, don't they, not doc comments. – trojanfoe Jun 16 '14 at 07:54
Thanks for the explanation so to achieve this functionality I must use appledoc – Majky Jun 16 '14 at 09:06
Yes, although it's not that simple as the generated documentation has to be installed into Xcode (look at how cocos2d do it), so it's not suitable for code you are currently developing. – trojanfoe Jun 16 '14 at 10:26

Cross reference in XCode comments

0 Answers0