/wiki/TagSee.wiki

 1#summary @see
 2
 3== The @see Tag ==
 4
 5The `@see` tag allows you to refer to another symbol or resource that may be related to the one being documented.
 6
 7=== Syntax ===
 8
 9{{{
10@see seeDescription
11}}}
12
13  * seeDescription - Required: a description of a resource to refer to for more information.
14
15=== Example ===
16
17If the first word is a documented symbol then that will become a link to the documentation, otherwise the text is displayed exactly as entered (meaning @link tags will not be rendered).
18
19{{{
20/**
21 * @see ClassName#methodName
22 * @see The <a href="http://www.example.com">Example Project</a>.
23 */
24}}}
25
26=== See Also ===
27
28  * The [TagLink @link] tag can be used to duplicate the behavior of @see outside of the @see tag.