DOC202.md

DOC202

TypeName	DOC202UseSectionElementsCorrectly
CheckId	DOC202
Category	Portability Rules

Cause

The documentation contains a section element where a block or inline element was expected.

Rule description

TODO

/// <summary>
/// Summary text.
/// <example>
/// Here is an example:
/// <code>
/// Console.WriteLine();
/// </code>
/// </example>
/// </summary>
public void SomeOperation()
{
}

How to fix violations

To fix a violation of this rule, move the section element outside the block or inline element context, or replace the section element with an appropriate block or inline element.

Option: Move the section element outside the block element

/// <summary>
/// Summary text.
/// </summary>
/// <example>
/// Here is an example:
/// <code>
/// Console.WriteLine();
/// </code>
/// </example>
public void SomeOperation()
{
}

Option: Use an appropriate block element instead of the section element

/// <summary>
/// Summary text.
/// <para>Here is an example:</para>
/// <code>
/// Console.WriteLine();
/// </code>
/// </summary>
public void SomeOperation()
{
}

How to suppress violations

TODO