Re: How to create Alt-click Help
Re: How to create Alt-click Help
- Subject: Re: How to create Alt-click Help
- From: Clemens Grossmann <email@hidden>
- Date: Mon, 05 Aug 2013 16:49:29 +0200
Thank you very much the link to creating doc sets (actual link is http://developer.apple.com/library/ios/#featuredarticles/DoxygenXcode/_index.html)!
Here is how far I get:
- Adding the doxygen comments to the source code made some of them show up with the option-click / alt-click in XCode 5 DP4 after restarting XCode. I am currently experimenting what works. So far no luck with XCode 4.6.3 with this.
- Creating a Doc Set with doxygen: this was very easy and returned an acceptable looking documentation even without fine tuning. After running "make install" in the generated file, this Doc Set is copied into ~/Library/Developer/Shared/Documentation/DocSets. It will still require some more tuning, because clicking in the resulting Doc Set crashes the XCode. But this may be because there is still to little documented inside or I made a mistake in the generation of the Doc Set.
- In XCode 5 DP 4 I could not find an add button for the documentation (with XCode 4 this is in Preferences|Downloads|Documentation) and the Doc Set did not show up. But I am fine with the quick help for my needs, and using doxygen to create more documentation.
Has anybody used HeaderDoc?
/Clemens
Am 05.08.2013 um 15:23 schrieb Fritz Anderson <email@hidden>:
> On Aug 5, 2013, at 6:21 AM, Clemens Grossmann <email@hidden> wrote:
>
>> I am creating a small framework and it would be great if users of the framework could get a brief documentation if they alt-click on the symbol.
>>
>> Is there any way to add this function?
>> Does XCode support some Javadoc like things to do this?
>>
>> Any help or suggestion would be great!
>
> First, let me indulge a peeve. The key you mention does include the label "alt," but it's in small lettering, indicating that the preferred name is "option," the name it has had since 1984. "Alt" is there to indicate the different effect it has when used with Windows applications.
>
> The feature you want is limited in Xcode 4. I've had a long-standing feature request that Xcode should parse documentation comments and render them as you describe. I believe others may have done so as well.
>
> Please read that last paragraph very closely.
>
> The current suggestion is to be found in an Apple documentation article with a title I don't remember, but is something like "using Doxygen to add documentation sets." This will add your documentation to the full documentation browser, but not all of your work will show up in the Quick Help text that appears in the Help imspector or in the popover you get by option-clicking.
>
> ― F
>
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden