RemoteApiDocUrlResolver.TryGetNamespaceUrl Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Attempts to retrieve the documentation URL for the specified namespace.

public bool TryGetNamespaceUrl(string ns, [NotNullWhen(true)] out Uri url)

Parameters

ns string: The namespace to retrieve the documentation URL for.
url Uri: When this method returns, contains the absolute documentation URL for the specified namespace, if the namespace has a documentation URL; otherwise, null. This parameter is passed uninitialized.

Returns

bool: true if the namespace has a documentation URL; otherwise, false.

Remarks

This method first checks if the specified namespace is covered by the namespace patterns of this URL resolver. If it is, it attempts to resolve the documentation URL for the namespace; otherwise, it returns false.