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

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

DocuHelper

Contains helper functions to run the XML documentation tool "docu".

Nested types and modules

TypeDescription
DocuParams
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The parameter type for docu.

Functions and values

Function or valueDescription
Docu setParams assemblies
Signature: setParams:(DocuParams -> DocuParams) -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Generates a HTML documentation from XML docs via the docu.exe.

Parameters

  • setParams - Function used to manipulate the default docu parameters.
  • assemblies - Sequence of one or more assemblies containing the XML docs.
DocuDefaults
Signature: DocuParams
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The Docu default params