BuildCommandParams (Fake)

Fsdocs.BuildCommandParams Type

Namespace: Fake.DotNet
Assembly: Fake.DotNet.Fsdocs.dll
Parent Module: Fsdocs
Base Type: obj
All Interfaces: IEquatable<BuildCommandParams> , IStructuralEquatable

Fsdocs build command parameters and options

Record fields

Record Field	Description
`Clean` Full Usage: `Clean` Field type: `bool option`	Clean the output directory Field type: `bool option`
`Eval` Full Usage: `Eval` Field type: `bool option`	Evaluate F# fragments in scripts Field type: `bool option`
`FscOptions` Full Usage: `FscOptions` Field type: `string option`	Additional arguments passed down as otherflags to the F# compiler when the API is being generated. Note that these arguments are trimmed, this is to overcome a limitation in the command line argument processing. A typical use-case would be to pass an addition assembly reference. Example --fscoptions " -r:MyAssembly.dll" Field type: `string option`
`IgnoreProjects` Full Usage: `IgnoreProjects` Field type: `bool option`	Disable project cracking. Field type: `bool option`
`Input` Full Usage: `Input` Field type: `string option`	Input directory of content (default: docs) Field type: `string option`
`LineNumbers` Full Usage: `LineNumbers` Field type: `bool option`	Add line numbers Field type: `bool option`
`MdComments` Full Usage: `MdComments` Field type: `bool option`	Assume comments in F# code are markdown (<UsesMarkdownComments>) Field type: `bool option`
`NoApiDocs` Full Usage: `NoApiDocs` Field type: `bool option`	Disable generation of API docs Field type: `bool option`
`NoDefaultContent` Full Usage: `NoDefaultContent` Field type: `bool option`	Do not copy default content styles, javascript or use default templates Field type: `bool option`
`NoPublic` Full Usage: `NoPublic` Field type: `bool option`	The tool will also generate documentation for non-public members Field type: `bool option`
`Output` Full Usage: `Output` Field type: `string option`	Output Directory (default output for build and tmp/watch for watch) Field type: `string option`
`Parameters` Full Usage: `Parameters` Field type: `seq<string * string> option`	Additional substitution parameters for templates Field type: `seq<string * string> option`
`Projects` Full Usage: `Projects` Field type: `seq<string> option`	Project files to build API docs for outputs, defaults to all packable projects Field type: `seq<string> option`
`Properties` Full Usage: `Properties` Field type: `string option`	Provide properties to dotnet msbuild, e.g. --properties Configuration=Release Version=3.4 Field type: `string option`
`Qualify` Full Usage: `Qualify` Field type: `bool option`	In API doc generation qualify the output by the collection name, e.g. 'reference/FSharp.Core/...' instead of 'reference/...' . Field type: `bool option`
`SaveImages` Full Usage: `SaveImages` Field type: `bool option`	Save images referenced in docs Field type: `bool option`
`SourceFolder` Full Usage: `SourceFolder` Field type: `string option`	Source folder at time of component build (<FsDocsSourceFolder>) Field type: `string option`
`SourceRepository` Full Usage: `SourceRepository` Field type: `string option`	Source repository for github links (<FsDocsSourceRepository>) Field type: `string option`
`Strict` Full Usage: `Strict` Field type: `bool option`	Fail if docs are missing or can't be generated Field type: `bool option`
`Version` Full Usage: `Version` Field type: `bool option`	Display version information Field type: `bool option`

Static members

Static member	Description
`BuildCommandParams.Default` Full Usage: `BuildCommandParams.Default` Returns: `BuildCommandParams`	Parameter default values. Returns: `BuildCommandParams`