Documentation created with appledoc no longer shows quickhelp option to view in Xcode's organizer (4.4) #235

Closed
ryanrhee opened this Issue Aug 9, 2012 · 17 comments

Projects

None yet

4 participants

@ryanrhee
ryanrhee commented Aug 9, 2012

When a method is opt+click'd, there is a quickhelp bubble. There used to be an option in this bubble to read more in the organizer, but this option is no longer available for appledoc-generated documentation, starting with Xcode 4.4.

@tomaz
Owner
tomaz commented Aug 9, 2012

I think Xcode requires you to specify --docset-platform-family with either
ios or macosx (not sure about exact phrasing, take a look into DocSet guide
from Apple) in order to have QuickHelp working.

On Thu, Aug 9, 2012 at 2:16 AM, Ryan notifications@github.com wrote:

When a method is opt+click'd, there is a quickhelp bubble. There used to
be an option to read more in the organizer, but this option is no longer
available starting with Xcode 4.4.


Reply to this email directly or view it on GitHubhttps://github.com/tomaz/appledoc/issues/235.

@ryanrhee
ryanrhee commented Aug 9, 2012

Quickhelp itself is working, just missing the link to view the contents in an organizer. This was present in 4.3.x.

I'll try tomorrow with --docset-platform-family with either ios or macosx, but I remember reading somewhere that this was being set by default for compatibility with Dash.

@tomaz
Owner
tomaz commented Aug 9, 2012

It was set as appledoc so Dash could optimize it, but as users discovered
side effects, we changed back to none and added new key to info.plist for
Dash.

On Thu, Aug 9, 2012 at 8:55 AM, Ryan notifications@github.com wrote:

Quickhelp itself is working, just missing the link to view the contents in
an organizer. This was present in 4.3.x.

I'll try tomorrow with --docset-platform-family with either ios or macosx,
but I remember reading somewhere that this was being set by default for
compatibility with Dash.


Reply to this email directly or view it on GitHubhttps://github.com/tomaz/appledoc/issues/235#issuecomment-7606735.

@ryanrhee
ryanrhee commented Aug 9, 2012

After tinkering with it a bit, I've noticed that if in Xcode 4.3.2, quickhelp works even if the docset platform family is not set, but in Xcode 4.4, it needs to be set.

HOWEVER, if the docset was added in 4.3.2, and quickhelp was working, when Xcode is updated to 4.4, quickhelp will still work, even if the docset platform family is not set, even when the documentation is regenerated. To break the said documentation in 4.4, one needs to remove the docset from the preferences, and re-run appledoc -- at which point, quickhelp will no longer work.

To make new docsets work with quickhelp, they do indeed need the docset platform family set.

However, the problem with the new Xcode 4.4 isn't that quickhelp isn't working at all, it's that there is one feature of quickhelp that's no longer working.

Here's a screenshot of what quickhelp shows on a built-in method. Notice the "Reference" link at the very bottom. Clicking this link will take the user to the exact method in the documentation, via the Organizer window. Such a link is not available for quickhelp on appledoc-generated docsets, on Xcode 4.4. This was working in 4.3.x

@tomaz
Owner
tomaz commented Aug 10, 2012

At least there's workaround... This is a case where predefined value won't do - I guess some folks prefer iOS, some OSX, but you can easily set this up as global setting, so it's there for all your projects (and override where applicable).

I guess Apple is changing how stuff works with updates. I only wish they some day come up with on-the-fly commenting system, such as C#/Visual Studio.

Oh, the link doesn't work.

@ryanrhee

The screnshot link?

@tomaz
Owner
tomaz commented Aug 10, 2012

Yea, the screenshot link. Oh, now it's fine :)

@tomaz
Owner
tomaz commented Aug 10, 2012

Now I see what you mean. Would have to check on DocSet guide if there's some node I could use to add such a link.

@ryanrhee

Is there a way to add that "Reference" link to appledoc-generated documentation?

EDIT: you're too quick for me, lol. :)

@tomaz
Owner
tomaz commented Aug 10, 2012

Just answered while you were typing :)

@ryanrhee

Thanks for looking into this! It's a pain in the neck not having the option to open the documentation in the organizer.

FWIW, I think the name of the function was a link in Xcode 4.3.x. Apple must have removed this functionality in 4.4. :(

EDIT: grammar

@tomaz
Owner
tomaz commented Aug 10, 2012

Quick scan into docs doesn't reveal any custom tag that would add reference line. But it may also be not yet documented at this point.

@gcerquant

Passing --docset-platform-family iphoneos for an iOS project fixed the Quick Help menu in Version 4.5.1.

I tried with --docset-platform-family ios and the menu would show up, but the documentation of the super class would appear instead of the one being looked up.

@tomaz
Owner
tomaz commented Oct 12, 2012

Thanks for clarifying.

@acrist
acrist commented Oct 12, 2012

Is there are any workaround for osx project?

@tomaz
Owner
tomaz commented Oct 14, 2012

Looking at Apple's docset's Info.plist files, for OS X you should use macosx as --docset-platform-family.

@acrist
acrist commented Oct 14, 2012

I have this settings, and it works for some classes, but not for others. Can find depends what is wrong.

@andreiaf andreiaf added a commit to andreiaf/appledoc that referenced this issue Feb 12, 2013
@andreiaf andreiaf Fixed issues #289, #235 for Xcode 4.4 and above
1. Xcode will crash on ALT-DoubleClick every time when trying to look up selected text in Xcode Organiser
2. ALT-Click shows QuickHelp bubble OK, but if the method is not from one of the standard framework classes, the 'Reference' link at the bottom of the pop-up is not shown.
   Thus you can't jump to Organiser help on  your own classes and methods from the Quick Help bubble.
3. Added sample Xcode integration script to generate dockets automatically as target

Fix Notes:
    1. modify template file "tokens-template.xml" to add node reference for methods
    2. modify "GBDocSetOutputGenerator.m" to add this node reference to the generated xml file
8b6e20f
@tomaz tomaz pushed a commit that closed this issue Feb 17, 2013
@andreiaf andreiaf - Fixed issue #318
- Fixed #235, #289, #315. Adder proper Quick Help Reference links for @property's getters and setters methods when they are explicitly defined in the code. Now the reference link in Quick Help (Alt+click) and Help Organiser (ALT+doubleclick) point to @property.
657afd7
@tomaz tomaz closed this in 657afd7 Feb 17, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment