overloads

The <overloads> tag provides documentation that applies to all the overloads of a member.

Short Form
<overloads>
   summary_description
</overloads>

Expanded Form
<overloads>
   <summary>summary_description</summary>
   [<remarks>remarks_description</remarks>]
   [<example>examples_description</example>]
</overloads>

where:

term: A term to define, which will be defined in description.
description: Either an item in a bullet or numbered list or the definition of a term.

Applies To

Property, Method, Event, Operator.

Remarks

This tag only needs to be specified on the first overload.

The tag can have two forms:

In the short form, it includes only one or more text blocks that are treated as the summary.
In the expanded form, it can include one or more applicable section tags (summary, remarks and example).

<overloads>

Applies To

Remarks

Examples

See Also