Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sometimes (?) cross reference links are consistently not generated #491

Open
LearnCocos2D opened this issue Nov 26, 2014 · 3 comments
Open

Comments

@LearnCocos2D
Copy link

I've come across this a couple times now using appledoc v2.2 (build 963).

In the class overview for class A I add the name of class B (a subclass of A in this case) yet appledoc will not create a link for that identifier.

Unfortunately there seems to be no workaround, I wish I could simply write [ClassB] to force generating a link to "ClassB". Using @see doesn't work either in the class overview.

This only seems to happen in some classes and I have yet to find the root cause for this. Sometimes changing the text that comes before the cross reference helps but in my current case the class overview just has a plain english sentence followed by a list of class names, all of which are missing the cross reference links.

Is this a known issue? Is there perhaps a workaround?

@LearnCocos2D
Copy link
Author

One explanation I might have: the particular class with the overview comment without cross references is in a header with many other interfaces (its subclasses). However not all of the missing links are to subclasses, one is to another class entirely (not related in any way) and it doesn't link to that class either.

Btw here's a screenshot of the output with the missing crossref links:
screen shot 2014-11-26 at 12 53 14

@LearnCocos2D
Copy link
Author

Following text creates the cross ref links for the CCAction classes:

/** Base class for instant actions, ie actions which perform their task immediately and quit.

 ### Subclasses

 - CCActionCallBlock, CCActionCallFunc (runs a block or selector)
 */

Adding this last list item removes the cross ref links from the class names (except for CCSprite which remains linked):

/** Base class for instant actions, ie actions which perform their task immediately and quit.

 ### Subclasses

 - CCActionCallBlock, CCActionCallFunc (runs a block or selector)
 - CCActionFlipX, CCActionFlipY (sets the [CCSprite setFlipX:] and [CCSprite setFlipY:] properties of a CCSprite)
 */

I narrowed it down to this, apparently the manual cross reference link causes the automatic class cross refs to break, this is the minimum text that made the cross refs disappear:

/** Base class for instant actions, ie actions which perform their task immediately and quit.

 ### Subclasses

 - CCActionCallBlock, CCActionCallFunc (runs a block or selector)
 - CCActionFlipX, CCActionFlipY sets the 

 [CCSprite setFlipX:]
 */

@LearnCocos2D
Copy link
Author

Interestingly, with this text all classes preceding `[CCNode removeFromParent]`` are not linked, but the classes following that text fragment do have links. My best guess is that the [] is in conflict with markdown and it expects or treats this as a markdown link ...

CCActionCallBlock, CCActionCallFunc (runs a block or runs a selector on a given target)
CCActionFlipX, CCActionFlipY (sets the flipX / flipY properties of a CCSprite)
CCActionPlace (sets the position property of a CCNode)
CCActionRemove (removes a CCNode from its parent, ie calls [CCNode removeFromParent])
CCActionShow, CCActionHide, CCActionToggleVisibility (sets the visible property of a CCNode)
CCActionSoundEffect (plays a sound effect via OALSimpleAudio)
CCActionSpriteFrame (sets the spriteFrame property of a CCSprite)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant