2014-04-27 12 views
6

Wyobrażam sobie, że brakuje mi czegoś w dokumentacji yuidoc lub nieporozumienia użycia. Nie mogę znaleźć sposobu na umieszczenie linku do zewnętrznej strony/strony w mojej dokumentacji.Jak dodać dodać linki zewnętrzne w yuidoc (grunt-contrib-yuidoc)

w komentarzu bloku, chciałbym mieć coś takiego:

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

Odpowiedz

7

Według dokumentu mówi:

YUIDoc obsługuje 3 głównych form formatowania dokumentów. HTML, Markdown & Selleck.

Więc można używać HTML lub Markdown tak:

/** 
* 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) 
* 
*/