ShowMissingComponent Class

Definition

Namespace

Sandcastle.Tools.BuildComponents

Assembly

Sandcastle.Tools.BuildComponents.dll

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.

public class ShowMissingComponent : BuildComponentCore, IDisposable

Inheritance

object

BuildComponentCore

ShowMissingComponent

Implements

IDisposable

Examples

<!-- Show missing documentation component configuration.  This must
     appear before the TransformComponent. -->
<component id="Show Missing Documentation Component">
    <!-- 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" />
</component>

Constructors

ShowMissingComponent(IBuildAssembler)

Constructor

Properties

BuildAssembler	This read-only property returns a reference to the build assembler instance using the component (Inherited from BuildComponentCore)
GroupId	This is used to set an optional group ID for use with component events (Inherited from BuildComponentCore)

Methods

Apply(XmlDocument, string)	This is implemented to add the missing documentation tags
Dispose()	This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore)
Initialize(XPathNavigator)	This abstract method must be overridden to initialize the component