IndexedCommentsCache.IndexCommentsFiles Method

Definition

Namespace

Sandcastle.Core.InheritedDocumentation

Assembly

Sandcastle.Core.dll

Index all comments files found in the specified folder.

public void IndexCommentsFiles(string path, string wildcard, bool recurse, ConcurrentBag<XPathNavigator> commentsFiles)

Parameters

path string

The path to search. If null or empty, the current directory is assumed.

wildcard string

The wildcard to use. If null or empty, "*.xml" is assumed.

recurse bool

True to recurse subfolders or false to only use the given folder.

commentsFiles ConcurrentBag<XPathNavigator>

Optional. If not null, an XPathDocument is added to the collection for each file indexed.

Remarks

The files are indexed in parallel.