UrlReference Class

Namespace

Kampute.DocToolkit.Routing

Assembly

Definition

Represents a non-API URL that has been referenced in the documentation.

public class UrlReference

Inheritance

UrlReference(DocumentUrlContext, string, Uri)	Initializes a new instance of the UrlReference class using the specified scope.
UrlReference(IDocumentModel, string, string, Uri)	Initializes a new instance of the UrlReference class using the referencing model and base directory.

BaseDirectory	Gets the directory path of the referencing model's documentation page, relative to the documentation root.
ReferencingModel	Gets the documentation model in which the URL is referenced.
SourceUrl	Gets the original URL string from the documentation source (e.g., XML comment or topic).
TargetUrl	Gets the URL corresponding to the SourceUrl in the generated documentation.

Returns a string that represents the current UrlReference.