@see

Summary

Refers to other documentation pages of interest.

Syntax

@see text path

Parameters

path
The title or relative path of the documentation page to refer to.

Description

The @see tag is used for referring to other documentation pages of interest (e.g. a "See Also" section).

The @see tag expects two arguments. The first argument is the link text and can include spaces. The second argument should be the relative path of the documentation page to link to or a URL to an external resource.

Examples

Documenting an 'add' Method (@see using external page)
1
2
3
4
5
6
7
8
9
10
11
12
class Calculator
{
    /**
     * Adds two numbers together and returns the result.
     *
     * @see Addition (Wikipedia) https://en.wikipedia.org/wiki/Addition
     */
    int add(int x, int y)
    {
        return x + y;
    }
}
Documenting an 'add' Method (@see using page relative path)
1
2
3
4
5
6
7
8
9
10
11
12
class Calculator
{
    /**
     * Adds two numbers together and returns the result.
     *
     * @see int JavaScript-PP/Language/Reference/Types/Primitive-Types/int
     */
    int add(int x, int y)
    {
        return x + y;
    }
}

Share

HTML | BBCode | Direct Link