SeeAlsoComment.WithResolvedHyperlink Method

Namespace

Kampute.DocToolkit.XmlDoc.Comments

Assembly

Kampute.DocToolkit.dll

Definition

Returns a new version of this see-also comment with resolved cross-reference and description, if its reference is a relative URL.

public SeeAlsoComment WithResolvedHyperlink(IDocumentationContext context)

Parameters

context IDocumentationContext: The documentation context that provides topic resolution and URL services.

Returns

SeeAlsoComment: A new SeeAlsoComment with a properly addressed cross-reference and descriptive text if applicable; otherwise, the original instance.

Exceptions

ArgumentNullException: Thrown when context is null.

Remarks

This method returns a new version of the see-also comment if its reference is a relative URL. The refinement process includes:

Applying the context's URL addressing strategy and translations to the reference
Using the target topic's title when the reference lacks descriptive text

You typically do not need to call this method directly, as it is automatically invoked during the processing of XML documentation comments.