DocumentationContextBuilder<TContext>.WithBaseUrl Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll
DocumentationContextBuilder<TContext>.WithBaseUrl(string)Sets the base URL for documentation links.
DocumentationContextBuilder<TContext>.WithBaseUrl(Uri)Sets the base URL for documentation links.

DocumentationContextBuilder<TContext>.WithBaseUrl(string)

Sets the base URL for documentation links.
public virtual DocumentationContextBuilder<TContext> WithBaseUrl(string baseUrl)

Parameters

baseUrl string
The base URL as a string.

Returns

DocumentationContextBuilder<TContext>
The current builder instance for method chaining.

Exceptions

ArgumentException
Thrown when baseUrl is null, empty, or whitespace.
UriFormatException
Thrown when baseUrl is not a valid absolute URI.

DocumentationContextBuilder<TContext>.WithBaseUrl(Uri)

Sets the base URL for documentation links.
public virtual DocumentationContextBuilder<TContext> WithBaseUrl(Uri baseUrl)

Parameters

baseUrl Uri
The base URL as a Uri.

Returns

DocumentationContextBuilder<TContext>
The current builder instance for method chaining.

Exceptions

ArgumentNullException
Thrown when baseUrl is null.
ArgumentException
Thrown when baseUrl is not an absolute URI.