IntelliSenseComponent Class
Definition
- Namespace
- Sandcastle.Tools.BuildComponents
- Assembly
- Sandcastle.Tools.BuildComponents.dll
This build component is used to generate IntelliSense files based on the documented APIs.
public class IntelliSenseComponent : BuildComponentCore, IDisposable- Inheritance
-
IntelliSenseComponent
- Implements
Examples
<!-- 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>
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.
Constructors
| IntelliSenseComponent(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 abstract method must be overridden to apply the build component's changes to the specified document. |
| Dispose() |
This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore) |
| Dispose(bool) |
Wait for the comments writer task to complete when disposed |
| Initialize(XPathNavigator) |
This abstract method must be overridden to initialize the component |