| TypeName | DOC102UseChildBlocksConsistentlyAcrossElementsOfTheSameKind |
| CheckId | DOC102 |
| Category | Style Rules |
The documentation for the element contains inline text, but the documentation for a sibling element of the same kind uses block-level elements.
A violation of this rule occurs when a documentation contains sibling elements of the same kind, where some siblings use
block-level content, but others do not. In the following example, one param element uses inline content, while another
param element uses block content.
/// <summary>
/// Summary text.
/// </summary>
/// <param name="x">Inline content.</param>
/// <param name="y">
/// <para>Block content.</para>
/// </param>
public void SomeOperation(int x, int y)
{
}To fix a violation of this rule, place the content in a block-level element, such as a <para> element.
/// <summary>
/// Summary text.
/// </summary>
/// <param name="x">
/// <para>Block content.</para>
/// </param>
/// <param name="y">
/// <para>Block content.</para>
/// </param>
public void SomeOperation(int x, int y)
{
}#pragma warning disable DOC102 // Use child blocks consistently across elements of the same kind
/// <summary>
/// Summary text.
/// </summary>
/// <param name="x">Inline content.</param>
/// <param name="y">
/// <para>Block content.</para>
/// </param>
public void SomeOperation(int x, int y)
#pragma warning restore DOC102 // Use child blocks consistently across elements of the same kind
{
}