DocumentationSource Class

This represents an assembly, an XML comments file, a Visual Studio managed code project (C#, VB.NET, etc.), or a Visual Studio solution containing one or more managed code projects from which information is obtained to build a help file.

Definition

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

C#View Source Request Example

public class DocumentationSource : INotifyPropertyChanged

VBView Source Request Example

Public Class DocumentationSource
	Implements INotifyPropertyChanged

C++View Source Request Example

public ref class DocumentationSource : INotifyPropertyChanged

F#View Source Request Example

type DocumentationSource = 
    class
        interface INotifyPropertyChanged
    end

Inheritance: Object DocumentationSource

Implements: INotifyPropertyChanged

Remarks

Wildcards are supported in the SourceFile property.

Properties

Assemblies	This read-only property returns an enumerable list of assemblies based on the current settings
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.
SourceDescription	This returns a description of the entry suitable for display in a bound list control or property grid
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

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)
OnPropertyChanged	This raises the PropertyChanged event
Projects	This returns an enumerable list of MSBuild project file configurations based on the current settings and the given configuration and platform.
ProjectsIn	This is used to get a list of all projects in a solution file regardless of configuration and platform.
ToString	Return a string representation of the item (Overrides ObjectToString)

Events

PropertyChanged

The property changed event