DocFxServeSettings Class

Summary

Contains settings used by Cake.DocFx.Serve.DocFxServeRunner.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx.Serve
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["DocFxServeSettings"] class Type type-node

Syntax

public class DocFxServeSettings : ToolSettings

Constructors

Name Summary
DocFxServeSettings()

Properties

Name Value Summary
Hostname string
Gets or sets the hostname on which to serve the content. Defaults to 'localhost'.
Port string
Gets or sets the local port on which to serve the content. Defaults to '8080'.

Extension Methods

Name Value Summary
Dump<DocFxServeSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DocFxServeSettings>(DocFxServeSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DocFxServeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DocFxServeSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DocFxServeSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DocFxServeSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin