InitParams (Fake)

DocFx.InitParams Type

Namespace: Fake.Documentation
Assembly: Fake.Documentation.DocFx.dll
Parent Module: DocFx
Base Type: obj
All Interfaces: IEquatable<InitParams> , IStructuralEquatable , IComparable<InitParams> , IComparable , IStructuralComparable

Init-Command parameters

Record Field	Description
`ApiSourceFolder` Full Usage: `ApiSourceFolder` Field type: `string`	Specify the source working folder for source project files to start glob search. Field type: `string`
`ApiSourceGlobPattern` Full Usage: `ApiSourceGlobPattern` Field type: `string`	Specify the source project files' glob pattern to generate metadata. Field type: `string`
`Common` Full Usage: `Common` Field type: `CommonParams`	Specify common docFx options Field type: `CommonParams`
`OnlyConfigFile` Full Usage: `OnlyConfigFile` Field type: `bool`	Generate config file docfx.json only, no project folder will be generated. Field type: `bool`
`OutputFolder` Full Usage: `OutputFolder` Field type: `string`	Specify the output folder of the config file. Defaults to docfx_project. Field type: `string`
`Overwrite` Full Usage: `Overwrite` Field type: `bool`	Specify if the current file will be overwritten if it exists. Field type: `bool`

Instance member Description

Instance member	Description
`this.WithCommon` Full Usage: `this.WithCommon` Parameters: f : `CommonParams -> CommonParams` Returns: `InitParams` Modifiers: inline	Changes the "Common" parameters according to the given function f : `CommonParams -> CommonParams` Returns: `InitParams`


                
                  
                    
                      this.WithCommon

Full Usage: this.WithCommon

Parameters:

f : CommonParams -> CommonParams

Returns: InitParams
Modifiers: inline

Changes the "Common" parameters according to the given function

Static member	Description
`InitParams.Create()` Full Usage: `InitParams.Create()` Returns: `InitParams`	Init default parameters Returns: `InitParams`