RemoteApiDocUrlResolver.TryGetMemberUrl Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Attempts to retrieve the documentation URL for the specified member.

public bool TryGetMemberUrl(IMember member, [NotNullWhen(true)] out Uri url)

Parameters

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

Returns

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

Remarks

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