IndexedCommentsCache.IndexCommentsFiles Method

Index all comments files found in the specified folder.

Definition

Namespace: SandcastleBuilder.Utils.InheritedDocumentation
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0

C#View SourceRequest Example
public void IndexCommentsFiles(
	string path,
	string wildcard,
	bool recurse,
	ConcurrentBag<XPathNavigator> commentsFiles
)

VBView SourceRequest Example
Public Sub IndexCommentsFiles ( 
	path As String,
	wildcard As String,
	recurse As Boolean,
	commentsFiles As ConcurrentBag(Of XPathNavigator)
)

C++View SourceRequest Example
public:
void IndexCommentsFiles(
	String^ path, 
	String^ wildcard, 
	bool recurse, 
	ConcurrentBag<XPathNavigator^>^ commentsFiles
)

F#View SourceRequest Example
member IndexCommentsFiles : 
        path : string * 
        wildcard : string * 
        recurse : bool * 
        commentsFiles : ConcurrentBag<XPathNavigator> -> unit 

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 Boolean: 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.

See Also

Reference

IndexedCommentsCache Class

SandcastleBuilder.Utils.InheritedDocumentation Namespace