Indexed
Index all comments files found in the specified folder.
Definition
Namespace: Sandcastle.Core.InheritedDocumentation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public void IndexCommentsFiles(
string path,
string wildcard,
bool recurse,
ConcurrentBag<XPathNavigator> commentsFiles
)VB
Public Sub IndexCommentsFiles (
path As String,
wildcard As String,
recurse As Boolean,
commentsFiles As ConcurrentBag(Of XPathNavigator)
)C++
public:
void IndexCommentsFiles(
String^ path,
String^ wildcard,
bool recurse,
ConcurrentBag<XPathNavigator^>^ commentsFiles
)F#
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 ConcurrentBagXPathNavigator
- Optional. If not null, an XPathDocument is added to the collection for each file indexed.
Remarks
The files are indexed in parallel.