CrossReferenceResolver

Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: System.Object

Syntax

CloudNimble.DotNetDocs.Core.CrossReferenceResolver

Summary

Resolves cross-references in documentation to their target entities and generates appropriate links.

Remarks

This class builds a comprehensive map of all documentation entities and their identifiers, allowing for resolution of see and seealso references to the correct relative paths and anchors. It handles all types of references including types, members, parameters, and external references.

Constructors

.ctor

Initializes a new instance of the CrossReferenceResolver class.

Syntax

public CrossReferenceResolver(CloudNimble.DotNetDocs.Core.ProjectContext context)

Parameters

Name	Type	Description
`context`	`CloudNimble.DotNetDocs.Core.ProjectContext`	The project context containing configuration and file naming options.

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

BuildReferenceMap

Builds the reference map from a documentation assembly.

Syntax

public void BuildReferenceMap(CloudNimble.DotNetDocs.Core.DocAssembly assembly)

Parameters

Name	Type	Description
`assembly`	`CloudNimble.DotNetDocs.Core.DocAssembly`	The documentation assembly to index.

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

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

ResolveReference

Resolves a documentation reference to a DocReference object with full path and anchor information.

Syntax

public CloudNimble.DotNetDocs.Core.DocReference ResolveReference(string rawReference, string currentPath)

Parameters

Name	Type	Description
`rawReference`	`string`	The raw reference string (e.g., “T:System.String” or “F:NamespaceMode.File”).
`currentPath`	`string`	The current document path for calculating relative paths.

Returns

Type: CloudNimble.DotNetDocs.Core.DocReference A resolved DocReference object.

ResolveReferences

Resolves all references in a collection of raw reference strings.

Syntax

public System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference> ResolveReferences(System.Collections.Generic.IEnumerable<string> rawReferences, string currentPath)

Parameters

Name	Type	Description
`rawReferences`	`System.Collections.Generic.IEnumerable<string>`	The collection of raw reference strings.
`currentPath`	`string`	The current document path for calculating relative paths.

Returns

Type: System.Collections.Generic.ICollection<CloudNimble.DotNetDocs.Core.DocReference> A collection of resolved DocReference objects.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Methods

​ BuildReferenceMap

​Syntax

​Parameters

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ResolveReference

​Syntax

​Parameters

​Returns

​ ResolveReferences

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Methods

BuildReferenceMap

Syntax

Parameters

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ResolveReference

Syntax

Parameters

Returns

ResolveReferences

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns