The <overloads> tag specifies a summary, remarks and examples common to all overloads of a member. This information will appear on the Overloads topic page and on Members list topic page. This is a top-level tag.

Only one overload should specify this tag. If it's specified in several overloads, the random one will be chosen. Two forms of this tag are available. The short form only contains common summary text for all overloads. It will appear on the Overloads topic page and on Members list topic page. In expanded form, you can add two more tags inside it - remarks and example. This information will appear on the Overloads topic page.

Syntax

Short form:

<overloads>summary_text</overloads>

Expanded form:

<overloads>

  <summary>summary_text</summary>

  [<remarks>remarks_text</remarks>]

  [<example>example_text</example>]

</overloads>

Examples

 

See Also