Adds an argument settings to the settings section. A VSdocman comment may contain any number of @set tags. Equivalent XML tag is <set>.

Syntax

@set parameter-name constant-name constant-value constant-description

parameter-name ... name of an argument for which the value setting is described.

constant-name ... argument value name.

constant-value ... argument value.

constant-description ... description of that value.

Usually there is no need for this tag because you should use enumerations as parameter types in such cases. The description may be continued on the next line. This tag is used in a method, function, property or event comment when some arguments are used. It describes possible setting for specified parameter. Every possible value requires one @set tag. Only 3 arguments per comment block can have specified settings, others are ignored. You can describe settings for arguments you want (e.g. arg1, arg3, arg6 in parameter-name field). If after them compiler encounters @set tag with parameter-name=arg2, this tag is ignored.

Example:

    '**

    'Our sample method.

    '@param        x The first parameter.

    '@set          x c1 1 first constant

    '@set          x c2 34 second constant

    '@return       True if no error occurs.

    Function method1(ByVal x As Integer) As Boolean

See Also

<set> tag