This build component is used to add "missing" notes for missing summary, parameter, returns, value, and remarks tags. It can also add default summary documentation for constructors.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 1.9.3.0

Syntax

C#
public class ShowMissingComponent : BuildComponent
Visual Basic
Public Class ShowMissingComponent _
	Inherits BuildComponent

Examples

CopyExample configuration
<!-- Show missing documentation component configuration.  This must
     appear before the TransformComponent. -->
<component type="SandcastleBuilder.Components.ShowMissingComponent"
  assembly="C:\SandcastleBuilder\SandcastleBuilder.Components.dll">
    <!-- All elements are optional. -->

    <!-- Auto-document constructors (true by default) -->
    <AutoDocumentConstructors value="true" />

    <!-- Auto-document dispose methods (true by default) -->
    <AutoDocumentDisposeMethods value="true" />

    <!-- Show missing param tags (true by default) -->
    <ShowMissingParams value="true" />

    <!-- Show missing typeparam tags (true by default) -->
    <ShowMissingTypeParams value="true" />

    <!-- Show missing remarks tags (false by default) -->
    <ShowMissingRemarks value="false" />

    <!-- Show missing returns tags (true by default) -->
    <ShowMissingReturns value="true" />

    <!-- Show missing summary tags (true by default) -->
    <ShowMissingSummaries value="true" />

    <!-- Show missing value tags (false by default) -->
    <ShowMissingValues value="false" />

    <!-- Show missing namespace comments (true by default) -->
    <ShowMissingNamespaces value="true" />

    <!-- Show missing include target docs (false by default) -->
    <ShowMissingIncludeTargets value="false" />

    <!-- Shared content file containing the localized
         messages (optional) -->
    <contentFile filename="C:\Working\SharedContent.xml" />
</component>

Inheritance Hierarchy

System..::..Object
  Microsoft.Ddue.Tools..::..BuildComponent
    SandcastleBuilder.Components..::..ShowMissingComponent

See Also