Declaring Type: DemoClass
Namespace: DemoProject
Assembly: DemoProject
| Signature | Description |
|---|---|
| Item[int, int] | An example of an indexer with two parameters. |
| Item[int] | An example of an indexer with a single parameter. |
| Item[object] | An example of an obsolete indexer. |
An example of an indexer with two parameters.
public string this[int x, int y] { get; }x int
Description of parameter x provided using the param element.
y int
Description of parameter y provided using the param element.
string
The tag value allows specifying the value a indexer represents
Remarks allow specification of more detailed information about a member, in this case the indexer. supplementing the information specified in the summary.
For overloaded members, there is a separate "Remarks" section for every overload.
An example of an indexer with a single parameter.
public string this[int index] { get; }index int
Description of parameter index provided using the param element.
string
The tag value allows specifying the value a indexer represents
Remarks allow specification of more detailed information about a member, in this case the indexer. supplementing the information specified in the summary.
For overloaded members, there is a separate "Remarks" section for every overload.
ArgumentException
Exceptions can be documented using the exception tag.
InvalidOperationException
Using the example tag, examples on how to call a member can be included in the documentation:
var instance = new DemoClass();
var value = instance[42];An example of an obsolete indexer.
[Obsolete("This indexer is obsolete. Use this[int,int] instead.")]
public string this[object arg] { get; }arg object
string
If a member is marked as obsolete using ObsoleteAttribute a warning is included in the generated documentation. The documentation also includes the message specified for the obsolete attribute.
Documentation generated by MdDocs