 | DocumentationSource Class |
This represents an assembly, an XML comments file, a Visual Studio Solution (C#, VB.NET, or J#), or a
Visual Studio solution containing one or more C#, VB.NET or J# projects to use for building a help file.
Inheritance HierarchySystemObject
SandcastleBuilder.UtilsPropertyBasedCollectionItem
SandcastleBuilder.UtilsDocumentationSource
SandcastleBuilder.UtilsPropertyBasedCollectionItem
SandcastleBuilder.UtilsDocumentationSource
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe DocumentationSource type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | Assemblies |
This returns a collection of assemblies based on the specified wildcard.
|
 | CheckProjectIsEditable |
This is used to see if the project can be edited. If not, abort
the change by throwing an exception.
(Inherited from PropertyBasedCollectionItem.) |
| CommentsFiles |
This returns a collection of XML comments files based on the specified wildcard.
|
| Equals |
See if specified item equals this one
(Overrides ObjectEquals(Object).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode |
Get a hash code for this item
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Projects |
This returns a collection of MSBuild project filenames based on the specified wildcard.
|
| ProjectsIn |
This is used to get a list of all projects in a solution file
|
| ToString |
Return a string representation of the item
(Overrides ObjectToString.) |
Properties| Name | Description | |
|---|---|---|
 | Configuration |
This is used to get or set the project configuration to use when the source path refers to a Visual
Studio solution or project.
|
| IncludeSubFolders |
This is used to get or set whether subfolders are included when searching for files if the
SourceFile value contains wildcards.
|
| IsDirty |
This is used to get or set the dirty state of the item
(Inherited from PropertyBasedCollectionItem.) |
| Platform |
This is used to get or set the project platform to use when the source path refers to a Visual Studio
solution or project.
|
| ProjectFile |
This is used to get the owning project file
(Inherited from PropertyBasedCollectionItem.) |
| SourceDescription |
This returns a description of the entry suitable for display in a bound list control
|
| SourceFile |
This is used to set or get the documentation source file path
|
RemarksWildcards are supported in the SourceFile property.
See Also