{{description}}

Summary

Used in documenting overloaded functions and methods. The macro expands to the individual overload's description.

Syntax

{{description}}

Description

The {{description}} macro is used in documenting overloaded functions and methods. The macro expands to an individual overload's description. Additional text can be included with the macro. The individual overloads will be documented with a description that include the expanded macro and any additional text. If the macro is not used, all overloads will be documented with the same text if the @overload tag is used.

Examples

Basic Usage
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class Calculator
{
    /**
     * @overload plus
     *
     * {{description}}
     *
     * In addition to the descriptions of the individual overloads, we can
     * include more descriptions and documentation text here...
     *
     * The individual overload descriptions will include their own
     * sub-descriptions in addition to anything we describe here when the
     * documentation has been generated.
     */
     /**
      * This description is what the macro will expand to.
      */
     int plus(int x, int y)
     {
        return plus(x, y, 0);
     }
     /**
      * This is another description that the macro will expand to.
      */
     int plus(int x, int y, int z)
     {
        return x + y + z;
     }
}

See Also

Share

HTML | BBCode | Direct Link