IntelliSenseComponent Class

This build component is used to generate IntelliSense files based on the documented APIs.

Definition

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

C#View Source Request Example

public class IntelliSenseComponent : BuildComponentCore

VBView Source Request Example

Public Class IntelliSenseComponent
	Inherits BuildComponentCore

C++View Source Request Example

public ref class IntelliSenseComponent : public BuildComponentCore

F#View Source Request Example

type IntelliSenseComponent = 
    class
        inherit BuildComponentCore
    end

Inheritance: Object BuildComponentCore IntelliSenseComponent

Remarks

Only the basic set of tags needed for IntelliSense are exported and only for documented API members. This is based on the Microsoft IntelliSense build component. That version only works with Microsoft-specific XML comments files and does not work with general XML comments files created by the compilers.

Example

Example configuration

<!-- IntelliSense component configuration.  This must appear
     before the TransformComponent. -->
<component id="IntelliSense Component">
 <!-- Output options (optional)
      Attributes:
         Include Namespaces (false by default)
         Namespaces filename ("Namespaces" if not specified or empty)
         Output folder (current folder if not specified or empty) -->
         Bounded cache capacity (0 if not specified) -->
 <output includeNamespaces="false" namespacesFile="Namespaces"
     folder="C:\ProjectDocs\" boundedCapacity="100" />
</component>

Constructors

IntelliSenseComponent

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 abstract method must be overridden to apply the build component's changes to the specified document. (Overrides BuildComponentCoreApply(XmlDocument, String))
Dispose	This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore)
Dispose(Boolean)	Wait for the comments writer task to complete when disposed (Overrides BuildComponentCoreDispose(Boolean))
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)