ShowMissingComponent Class

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.

Definition

Namespace: Sandcastle.Tools.BuildComponents
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.9.12.0

C#View Source Request Example

public class ShowMissingComponent : BuildComponentCore

VBView Source Request Example

Public Class ShowMissingComponent
	Inherits BuildComponentCore

C++View Source Request Example

public ref class ShowMissingComponent : public BuildComponentCore

F#View Source Request Example

type ShowMissingComponent = 
    class
        inherit BuildComponentCore
    end

Inheritance: Object BuildComponentCore ShowMissingComponent

Example

Example configuration

<!-- 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

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	This is implemented to add the missing documentation tags (Overrides BuildComponentCoreApply(XmlDocument, String))
Dispose	This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore)
Dispose(Boolean)	This can be overridden by derived classes to add their own disposal code if necessary. (Inherited from BuildComponentCore)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	This handles garbage collection to ensure proper disposal of the build component if not done explicitly with Dispose. (Inherited from BuildComponentCore)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
Initialize	This abstract method must be overridden to initialize the component (Overrides BuildComponentCoreInitialize(XPathNavigator))
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnComponentEvent	This can be used to raise the ComponentEvent event with the specified event arguments. (Inherited from BuildComponentCore)
ToString	Returns a string that represents the current object. (Inherited from Object)
WriteMessage(MessageLevel, String, Object)	This can be used to report a message (Inherited from BuildComponentCore)
WriteMessage(String, MessageLevel, String, Object)	This can be used to report a message for a specific topic ID (Inherited from BuildComponentCore)