Table of Contents

IndexedCommentsCache Class

Definition

Namespace
Sandcastle.Core.InheritedDocumentation
Assembly
Sandcastle.Core.dll

This is used to cache indexed XML comments files

public class IndexedCommentsCache
Inheritance
IndexedCommentsCache

Constructors

IndexedCommentsCache(int)

Constructor

Properties

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

ShowDuplicatesWarning

This is used to get or set whether or not duplicate entry warnings are generated

this[string]

This read-only property returns the comments for the specified key

Methods

GetKeys(string)

This returns an enumerable list of all key values from the specified XML file based on the expressions for this cache.

GetValues(string)

This returns an enumerable list of all key/value pairs from the specified XML file based on the expressions for this cache.

IndexCommentsFiles(string, string, bool, ConcurrentBag<XPathNavigator>)

Index all comments files found in the specified folder.

OnReportWarning(CommentsCacheEventArgs)

This is used to raise the ReportWarning event

Events

ReportWarning

This is used by the cache to report duplicate key warnings