DocumentationSet.AddSourceFilesInDirectoryTree Method

Adds to this documentation set each source file with a supported file name extension (for example, ".cs") within a given directory tree.

Parent Type: DocumentationSet

Namespace: DwellNet.CodeDoc

Assembly: CodeDocApi.dll

Syntax
C#

public void AddSourceFilesInDirectoryTree (
string treePath,
string relativePath,
List<Regex> excludeFilePaths,
string assemblyName

)

Parameters

treePath

The full path to the root of the directory tree.

relativePath

For each source file in the tree, its path relative to treePath, e.g. "Def\Ghi.cs", is appended to relativePath, e.g. "Abc", resulting in a compound relative path, e.g. "Abc\Def\Ghi.cs", that's used as the SourceFile.SourceFileRelativePath property. Use "" for no prefix.

excludeFilePaths

For each source file in the tree, if its path is matched by any regular expression in this list, the source file is ignored. This parameter is ignored if null.

assemblyName

Specifies the name of the assembly that contains the code compiled from these source files, or null to specify none. If specified, the assembly name is included in topic HTML.