Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found
here.
If the API is already migrated you can check here if exists in a module.
More information regarding the migration can be found here
InitParams
Init-Command parameters
Record Fields
| Record Field | Description |
ApiSourceFolder
Signature: string
|
Specify the source working folder for source project files to start glob search. |
ApiSourceGlobPattern
Signature: string
|
Specify the source project files' glob pattern to generate metadata. |
Common
Signature: CommonParams
|
Specify common docFx options |
OnlyConfigFile
Signature: bool
|
Generate config file docfx.json only, no project folder will be generated. |
OutputFolder
Signature: string
|
Specify the output folder of the config file. Defaults to docfx_project. |
Overwrite
Signature: bool
|
Specify if the current file will be overwritten if it exists. |
Instance members
| Instance member | Description |
x.WithCommon(f)
Signature: (f:(CommonParams -> CommonParams)) -> InitParams
|
Changes the "Common" parameters according to the given function |
Static members
| Static member | Description |
InitParams.Create()
Signature: unit -> InitParams
|
Init default parameters |