Re: adding a link to another JS file?

1,058 views
Skip to first unread message

Josh Rhoades

unread,
Jan 26, 2013, 11:03:35 PM1/26/13
to jsdoc...@googlegroups.com
I don't know of a way to do this directly from file to file in JSDoc, but you can get pretty close to what you are trying to do, I think.

For example, if you have a file named ns.app.js and it is declared as a namespace (* @namespace), then JSDoc will generate an HTML page for that under Namespaces, named ns.app.html. If you do a * @see ns.app in other JSDocs (file/method/namespace jsdoc blocks) will link to the ns.app page and all its methods/members/classes/child namespaces. I use this all the time to cross-link references throughout various namespaces or methods.

On Tuesday, October 9, 2012 6:35:36 PM UTC-7, mathematical.coffee wrote:
Hi all,

I'm just new to JSDoc3/JSDoc and struggling to learn what links are available, having found just the http://usejsdoc.org/ site to get a list of tags I can use, so the question might be a dumb one.

I have a file `a.js` and `b.js`. In `b.js`'s @fileOverview, I want to say "See `a.js` for more details on ....".

Is there some way to link to `a.js` from within `b.js` such that clicking on it will take me to the summary for that file? `{@link: a.js}` didn't work.

cheers.
Reply all
Reply to author
Forward
0 new messages