Skip to main content

Definition

Assembly: CloudNimble.EasyAF.Tools.dll Namespace: CloudNimble.EasyAF.Tools.ProjectDiscovery Inheritance: System.Object

Syntax

CloudNimble.EasyAF.Tools.ProjectDiscovery.ProjectInfo

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

public ProjectInfo()

.ctor

Initializes a new instance of the ProjectInfo class with a project path.

Syntax

public ProjectInfo(string projectPath)

Parameters

NameTypeDescription
projectPathstringThe path to the project file.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AssemblyName

Gets or sets the assembly name for the project.

Syntax

public string AssemblyName { get; set; }

Property Value

Type: string

DocumentationFile

Gets or sets the XML documentation file path pattern.

Syntax

public string DocumentationFile { get; set; }

Property Value

Type: string

GeneratesDocumentation

Gets or sets whether this project generates XML documentation.

Syntax

public bool GeneratesDocumentation { get; set; }

Property Value

Type: bool

IsTemplateProject

Gets or sets whether this is a template project.

Syntax

public bool IsTemplateProject { get; set; }

Property Value

Type: bool

IsTestProject

Gets or sets whether this is a test project.

Syntax

public bool IsTestProject { get; set; }

Property Value

Type: bool

IsToolProject

Gets or sets whether this is a tool project.

Syntax

public bool IsToolProject { get; set; }

Property Value

Type: bool

LatestTargetFramework

Gets or sets the latest (highest version) target framework.

Syntax

public string LatestTargetFramework { get; set; }

Property Value

Type: string

ProjectDirectory

Gets or sets the project directory path.

Syntax

public string ProjectDirectory { get; set; }

Property Value

Type: string

ProjectName

Gets or sets the project name (without extension).

Syntax

public string ProjectName { get; set; }

Property Value

Type: string

ProjectPath

Gets or sets the full path to the project file.

Syntax

public string ProjectPath { get; set; }

Property Value

Type: string

TargetFrameworks

Gets the collection of target frameworks for this project.

Syntax

public System.Collections.Generic.List<string> TargetFrameworks { get; set; }

Property Value

Type: System.Collections.Generic.List<string>

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetAllDocumentationFilePaths

Gets all XML documentation file paths for all target frameworks.

Syntax

public System.Collections.Generic.Dictionary<string, string> GetAllDocumentationFilePaths()

Returns

Type: System.Collections.Generic.Dictionary<string, string> A dictionary mapping target frameworks to documentation file paths.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetLatestDocumentationFilePath

Gets the XML documentation file path for the latest target framework.

Syntax

public string GetLatestDocumentationFilePath()

Returns

Type: string The path to the XML documentation file, or empty string if not available.

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ShouldIncludeInDocumentation

Determines whether this project should be included in documentation generation.

Syntax

public bool ShouldIncludeInDocumentation()

Returns

Type: bool True if the project should be included; otherwise, false.

ToString Override

Returns a string representation of the project information.

Syntax

public override string ToString()

Returns

Type: string A string containing the project name and target frameworks.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?