Skip to content

Cross-referencing Modules and Classes #11

Closed
bobbyearl opened this Issue May 10, 2012 · 5 comments

4 participants

@bobbyearl

Unable to generate links to other modules and classes using {{#crossLink Foo}} (where Foo is a module or class), as documented on http://yui.github.com/yuidoc/syntax/index.html#cross-referencing-modules-and-classes.

@davglass davglass was assigned May 10, 2012
@davglass
YUI Library member

The docs are actually wrong there. Handlebars code is not supported in Doc comments, it's supported in Templates. I plan on adding that but the Markdown parser actually destroys the Handlebars code before Handlebars get's to it.

@bobbyearl

Thanks for the quick reply! Looking forward to seeing that added.

@gpbl
gpbl commented May 16, 2012

+1 for Handlebars in doc comments. Would it also work for properties, events, methods? ^_^

@davglass
YUI Library member

I released 0.3.6 just now with support for this and more:

http://yui.github.com/yuidoc/syntax/index.html#cross-referencing-modules-and-classes

@davglass davglass closed this May 16, 2012
@maheshjag

Discovered a minor bug. We have a class library under a custom $N namespace. Cross-linking one of the classes from another one (even in the same module) by specifying a fully-qualified name results in the link containing back slashes '\', and not forward (normal) slashes '/'. This breaks the link.

Should I file this as a separate bug?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.