Definition
Assembly: CloudNimble.EasyAF.Tools.dll Namespace: CloudNimble.EasyAF.Tools.ProjectDiscovery Inheritance: System.ObjectSyntax
Summary
Represents information about a discovered project.Remarks
This class contains metadata about a project file, including its path, target frameworks, output directories, and XML documentation settings. It is used by the project discovery system to identify eligible projects for documentation generation.Constructors
.ctor
Initializes a new instance of the ProjectInfo class.Syntax
.ctor
Initializes a new instance of the ProjectInfo class with a project path.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
projectPath | string | The path to the project file. |
.ctor Inherited
Inherited from
objectSyntax
Properties
AssemblyName
Gets or sets the assembly name for the project.Syntax
Property Value
Type:string
DocumentationFile
Gets or sets the XML documentation file path pattern.Syntax
Property Value
Type:string
GeneratesDocumentation
Gets or sets whether this project generates XML documentation.Syntax
Property Value
Type:bool
IsTemplateProject
Gets or sets whether this is a template project.Syntax
Property Value
Type:bool
IsTestProject
Gets or sets whether this is a test project.Syntax
Property Value
Type:bool
IsToolProject
Gets or sets whether this is a tool project.Syntax
Property Value
Type:bool
LatestTargetFramework
Gets or sets the latest (highest version) target framework.Syntax
Property Value
Type:string
ProjectDirectory
Gets or sets the project directory path.Syntax
Property Value
Type:string
ProjectName
Gets or sets the project name (without extension).Syntax
Property Value
Type:string
ProjectPath
Gets or sets the full path to the project file.Syntax
Property Value
Type:string
TargetFrameworks
Gets the collection of target frameworks for this project.Syntax
Property Value
Type:System.Collections.Generic.List<string>
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetAllDocumentationFilePaths
Gets all XML documentation file paths for all target frameworks.Syntax
Returns
Type:System.Collections.Generic.Dictionary<string, string>
A dictionary mapping target frameworks to documentation file paths.
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetLatestDocumentationFilePath
Gets the XML documentation file path for the latest target framework.Syntax
Returns
Type:string
The path to the XML documentation file, or empty string if not available.
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ShouldIncludeInDocumentation
Determines whether this project should be included in documentation generation.Syntax
Returns
Type:bool
True if the project should be included; otherwise, false.
ToString Override
Returns a string representation of the project information.Syntax
Returns
Type:string
A string containing the project name and target frameworks.
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?