Skip to main content

​
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

NameTypeDescription
contextCloudNimble.DotNetDocs.Core.ProjectContextThe 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

NameTypeDescription
assemblyCloudNimble.DotNetDocs.Core.DocAssemblyThe documentation assembly to index.

​
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

​
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

NameTypeDescription
objAobject?-
objBobject?-

​
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

NameTypeDescription
rawReferencestringThe raw reference string (e.g., “T:System.String” or “F:NamespaceMode.File”).
currentPathstringThe 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

NameTypeDescription
rawReferencesSystem.Collections.Generic.IEnumerable<string>The collection of raw reference strings.
currentPathstringThe 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?