 | IndexedCommentsCache Class |
This is used to cache indexed XML comments files
Inheritance HierarchyNamespace: SandcastleBuilder.Utils.InheritedDocumentation
Assemblies: GenerateInheritedDocs (in GenerateInheritedDocs.exe) Version: 2014.11.22.0
SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe IndexedCommentsCache type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IndexedCommentsCache |
Constructor
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetKeys |
This returns an enumerable list of all key values from the specified XML file based on the
expressions for this cache.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValues |
This returns an enumerable list of all key/value pairs from the specified XML file based on the
expressions for this cache.
|
| IndexCommentsFiles |
Index all comments files found in the specified folder.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnReportWarning |
This is used to raise the ReportWarning event
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | AllKeys |
This read-only property returns all keys in the index
|
| FilesIndexed |
This read-only property returns the number of comments files that were indexed
|
| IndexCount |
This read-only property returns the number of items indexed
|
| Item |
This read-only property returns the comments for the specified key
|
| ShowDuplicatesWarning |
This is used to get or set whether or not duplicate entry warnings are generated
|
Events| Name | Description | |
|---|---|---|
 | ReportWarning |
This is used by the cache to report duplicate key warnings
|
See Also