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

How to document and crosslink my "foo.Object" class? #428

Open
xeolabs opened this issue Nov 13, 2016 · 0 comments
Open

How to document and crosslink my "foo.Object" class? #428

xeolabs opened this issue Nov 13, 2016 · 0 comments

Comments

@xeolabs
Copy link

xeolabs commented Nov 13, 2016

Is there a YUIDoc technique that would allow me to document a "foo.Object" class, while using the "foo" module namespace, and get links to that class page, rather than YUIDoc thinking I mean the JavaScript Object?

In other words, if I document a class like this:

/**
 @class Object
 @module foo
 @constructor
 */

Then reference it like this (while implying on the namespace):

{{#crossLink "Object"}}{{/crossLink}}

then, understandably, YUIDoc thinks I'm referencing the JavaScript native "Object".

Is there a way to force YUIDoc to infer my foo.Object object from this crosslink?

@xeolabs xeolabs changed the title How to document "foo.Object", with crosslinks, without specifying "foo"? How to document and crosslink my "foo.Object" class? Nov 13, 2016
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