Alex Rivera | Logout

Create "Quick Help" Entry in Xcode

Asked 2010-11-26T15:55:39.560
35

How do I create quick help entries in Xcode for my own code? I just want it as a coding support, meaning like the Eclipse functionality when coding Java. In eclipse you get a comment you entered above a method when hovering a method somewhere else.

The Xcode equivalent seems to be the "Quick Help".

Is there really no other way than using Doxygen? Doxygen seems like overkill for the small project I'm working on. At the moment I do know for sure that I only want the quick help populated thoroughly, so please avoid any hints like, "you have to create a documentation for your project".

I would really appreciate any help as the only thing I could find on this topic was this question.

But as you can see, no solution is available.

objective-c xcode doxygen comments code-documentation
Edit
Report

2 Answers

29

Yes... you can.. Here is a ready-made "Snippet" you can drag or auto-complete, etc...

/** 
 * <#summary#>
 * @param <#name#> <#how you gonna get it?#>
 * @param <#name#> <#really, there's more?#>
 * @return <#name#> <#what do you want!#>
 */

Drag that "onto" the snippet "thing" and like, you know.. set it up.. enter image description here

and there ya have it...

enter image description here

answered 2013-07-10T17:31:59.317
9

I think the only way is to create a Documentation Set for your code and then install it on XCode:

Xcode 4′s contextual help, which Apple calls “Quick Help,” relies entirely on the installed documentation sets. Xcode 4 automatically downloads the documentation sets (including updates) for the Mac OS and iOS APIs but you can install third-party sets as well.

(...)

Once you create your documentation set, you can install it in Xcode’s preferences (under the Documentation tab). Assuming the doc set is correctly built and installed, Quick Help should “just work.” Of course this is of limited use unless you’re sharing complex API with a group or the wide world.

source: http://xcodebook.com/2011/04/providing-your-own-quick-help/

Apple's Documentation Set guide: http://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/Documentation_Sets/

answered 2011-07-08T16:55:37.653

Your Answer