MetadataParams (Fake)

DocFx.MetadataParams Type

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

Metadata-Command parameters

Record fields

Record Field	Description
`Common` Full Usage: `Common` Field type: `CommonParams`	Specify common docFx options Field type: `CommonParams`
`ConfigFile` Full Usage: `ConfigFile` Field type: `string`	Specify the config file path. Field type: `string`
`DisableGitFeatures` Full Usage: `DisableGitFeatures` Field type: `bool`	Disable fetching Git related information for articles. By default it is enabled and may have side effect on performance when the repo is large. Field type: `bool`
`FilterConfigFile` Full Usage: `FilterConfigFile` Field type: `string`	Specify the filter config file. Field type: `string`
`ForceRebuild` Full Usage: `ForceRebuild` Field type: `bool`	Force re-generate all the metadata. Field type: `bool`
`GlobalNamespaceId` Full Usage: `GlobalNamespaceId` Field type: `string`	Specify the name to use for the global namespace. Field type: `string`
`LogParams` Full Usage: `LogParams` Field type: `LogParams`	Specify Logging parameter Field type: `LogParams`
`MSBuildProperties` Full Usage: `MSBuildProperties` Field type: `string`	--property =;= An optional set of MSBuild properties used when interpreting project files. These are the same properties that are passed to msbuild via the /property:=;= command line argument. Field type: `string`
`OutputFolder` Full Usage: `OutputFolder` Field type: `string`	Specify the output base directory. Field type: `string`
`PreserveRawInlineComments` Full Usage: `PreserveRawInlineComments` Field type: `bool`	Preserve the existing xml comment tags inside 'summary' triple slash comments. Field type: `bool`
`Projects` Full Usage: `Projects` Field type: `string list`	Specify project files. Field type: `string list`
`ShouldSkipMarkup` Full Usage: `ShouldSkipMarkup` Field type: `bool`	Skip to markup the triple slash comments. Field type: `bool`

Instance members

Instance member Description

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


                
                  
                    
                      this.WithCommon

Full Usage: this.WithCommon

Parameters:

f : CommonParams -> CommonParams

Returns: MetadataParams
Modifiers: inline

Changes the "Common" parameters according to the given function

f : CommonParams -> CommonParams

Returns: MetadataParams


                
                  
                    
                      this.WithLogParams

Full Usage: this.WithLogParams

Parameters:

f : LogParams -> LogParams

Returns: MetadataParams
Modifiers: inline

Changes the "LogParams" according to the given function

f : LogParams -> LogParams

Returns: MetadataParams

Static members

Static member	Description
`MetadataParams.Create()` Full Usage: `MetadataParams.Create()` Returns: `MetadataParams`	Metadata default parameters Returns: `MetadataParams`