ProjectDiscoveryService

Service for discovering and analyzing .NET projects in a solution.

Definition

Assembly: CloudNimble.EasyAF.Tools.dll

Namespace: CloudNimble.EasyAF.Tools.ProjectDiscovery

Inheritance: System.Object

Syntax

CloudNimble.EasyAF.Tools.ProjectDiscovery.ProjectDiscoveryService

Summary

Service for discovering and analyzing .NET projects in a solution.

Remarks

This service scans for solution files, project files, and analyzes their configurations to identify projects that are eligible for documentation generation. It handles multi-targeting scenarios and determines the best documentation files to use.

Constructors

.ctor

Syntax

public ProjectDiscoveryService()

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

AnalyzeProject

Analyzes a single project file to extract project information.

Syntax

public CloudNimble.EasyAF.Tools.ProjectDiscovery.ProjectInfo AnalyzeProject(string projectPath)

Parameters

Name	Type	Description
projectPath	string	The path to the project file.

Returns

Type: CloudNimble.EasyAF.Tools.ProjectDiscovery.ProjectInfo The project information, or null if the project cannot be analyzed.

DiscoverProjects

Discovers all eligible projects in the specified directory.

Syntax

public System.Collections.Generic.List<CloudNimble.EasyAF.Tools.ProjectDiscovery.ProjectInfo> DiscoverProjects(string rootDirectory, string specificProject = null)

Parameters

Name	Type	Description
rootDirectory	string	The root directory to search.
specificProject	string	Optional specific project name to filter by.

Returns

Type: System.Collections.Generic.List<CloudNimble.EasyAF.Tools.ProjectDiscovery.ProjectInfo> A collection of discovered project information.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

FindSolutionFile

Finds the solution file in the specified directory.

Syntax

public string FindSolutionFile(string directory)

Parameters

Name	Type	Description
directory	string	The directory to search.

Returns

Type: string The path to the solution file, or null if not found.

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

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

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?