PageRenderTime 24ms CodeModel.GetById 18ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 1ms

/wiki/TagLink.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 30 lines | 20 code | 10 blank | 0 comment | 0 complexity | 73afaae1df200514ff3ec84ee377eeb8 MD5 | raw file
 1#summary @link
 2
 3== The {@link} Tag ==
 4
 5The `{@link}` tag allows you to create a HTML link to some other documented symbol from within the text of any tag's description.
 6
 7=== Syntax ===
 8
 9{{{
10@anyTag This is some text {@link otherSymbol}.
11}}}
12
13  * anyTag - Can be any other tag.
14  * otherSymbol - Required: the namepath to the symbol you wish to link to.
15
16=== Example ===
17
18{{{
19/**
20 * This is similar to a {@link Printer} object but can also print to files.
21 */
22function Writer() {
23}
24}}}
25
26Note that !JsDoc Toolkit will automatically calculate where the documentation for `Printer` is and build the HTML link for you.
27
28=== See Also ===
29
30  * While the @link tag works like the [TagSee @see] tag, it actually isn't allowed in that particular tag.