Click or drag to resize
Sandcastle Help File BuilderIndexedCommentsCacheIndexCommentsFiles Method
Index all comments files found in the specified folder.

Namespace: SandcastleBuilder.Utils.InheritedDocumentation
Assemblies:  GenerateInheritedDocs (in GenerateInheritedDocs.exe) Version: 2014.11.22.0
  SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax
public void IndexCommentsFiles(
	string path,
	string wildcard,
	bool recurse,
	ConcurrentBag<XPathNavigator> commentsFiles
)

Parameters

path
Type: SystemString
The path to search. If null or empty, the current directory is assumed.
wildcard
Type: SystemString
The wildcard to use. If null or empty, "*.xml" is assumed.
recurse
Type: SystemBoolean
True to recurse subfolders or false to only use the given folder.
commentsFiles
Type: System.Collections.ConcurrentConcurrentBagXPathNavigator
Optional. If not null, an XPathDocument is added to the collection for each file indexed.
Remarks
The files are indexed in parallel.
See Also