Geek Answers Handbook

How to add sitelinks to yuidoc (grunt-contrib-yuidoc)

I assume that I have something missing in the yuidoc documentation or misuse. I cannot find a way to include a link to an external site / page in my documentation.

In the comments block, I would like to have something like this:

/** * Creates a blah-blah for blah-blahing blah. * * @constructor * @param {object} blah * * Follow recommendations at: * @link <a href="http://blah.com/boop">Boop</a> */
+6
source share
1 answer

The document says:

YUIDoc supports 3 main forms of formatting your documentation. HTML, Markdown, and Selleck.

So you can use HTML or Markdown as follows:

 /** * Creates a blah-blah for blah-blahing blah. * * @constructor * @param {object} blah * * Follow recommendations at: * <a href="http://blah.com/boop">Boop</a> * Or * [Boop](http://blah.com/boop) * */
+7
source

More articles:


All Articles