IDocumentationSource Interface
Definition
- Namespace
- Sandcastle.Core.Project
- Assembly
- Sandcastle.Core.dll
This defines the interface used to interact with a help file builder project documentation source
public interface IDocumentationSourceProperties
| CommentsFiles |
This read-only property returns an enumerable list of XML comments files based on the current settings |
| 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. |
| 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. |
| SourceFile |
This is used to set or get the documentation source file path |
| TargetFramework |
This is used to get or set the project target framework to use when the source path refers to a Visual Studio solution or project. |
Methods
| Projects(string, string) |
This returns an enumerable list of MSBuild project file configurations based on the current settings and the given configuration and platform. |