ApiDocs (FSharp.Formatting) | FSharp.Formatting

FSharp.Formatting

ApiDocs Type

Namespace: FSharp.Formatting.ApiDocs
Assembly: FSharp.Formatting.ApiDocs.dll
Base Type: obj

This type exposes the functionality for producing documentation model from `dll` files with associated `xml` files generated by the F# or C# compiler. To generate documentation model, use one of the overloades of the `Generate` method.

Static members

Static member	Description
`ApiDocs.GenerateHtml(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)` Full Usage: `ApiDocs.GenerateHtml(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)` Parameters: inputs : `ApiDocInput list` - the components to generate documentation for output : `string` - the output directory collectionName : `string` - the overall collection name substitutions : `Substitutions` - the substitutions to use in content and templates ?template : `string` - the template to use for each documentation page ?root : `string` - The root url of the generated documentation within the website ?qualify : `bool` - qualify the output set by collection name, e.g. `reference/FSharp.Core/...` ?libDirs : `string list` - Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments ?otherFlags : `string list` - Additional flags that are passed to the F# compiler to specify references explicitly etc. ?urlRangeHighlight : `Uri -> int -> int -> string` - A function that can be used to override the default way of generating GitHub links ?onError : `string -> unit` Returns: `ApiDocModel * ApiDocsSearchIndexEntry[]`	Generates default HTML pages for the assemblies specified by the `inputs` parameter inputs : `ApiDocInput list` the components to generate documentation for output : `string` the output directory collectionName : `string` the overall collection name substitutions : `Substitutions` the substitutions to use in content and templates ?template : `string` the template to use for each documentation page ?root : `string` The root url of the generated documentation within the website ?qualify : `bool` qualify the output set by collection name, e.g. `reference/FSharp.Core/...` ?libDirs : `string list` Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments ?otherFlags : `string list` Additional flags that are passed to the F# compiler to specify references explicitly etc. ?urlRangeHighlight : `Uri -> int -> int -> string` A function that can be used to override the default way of generating GitHub links ?onError : `string -> unit` Returns: `ApiDocModel * ApiDocsSearchIndexEntry[]`
`ApiDocs.GenerateMarkdown(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)` Full Usage: `ApiDocs.GenerateMarkdown(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)` Parameters: inputs : `ApiDocInput list` - the components to generate documentation for output : `string` - the output directory collectionName : `string` - the overall collection name substitutions : `Substitutions` - the substitutions to use in content and templates ?template : `string` - the template to use for each documentation page ?root : `string` - The root url of the generated documentation within the website ?qualify : `bool` - qualify the output set by collection name, e.g. `reference/FSharp.Core/...` ?libDirs : `string list` - Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments ?otherFlags : `string list` - Additional flags that are passed to the F# compiler to specify references explicitly etc. ?urlRangeHighlight : `Uri -> int -> int -> string` - A function that can be used to override the default way of generating GitHub links ?onError : `string -> unit` Returns: `ApiDocModel * ApiDocsSearchIndexEntry[]`	Generates default Markdown pages for the assemblies specified by the `inputs` parameter inputs : `ApiDocInput list` the components to generate documentation for output : `string` the output directory collectionName : `string` the overall collection name substitutions : `Substitutions` the substitutions to use in content and templates ?template : `string` the template to use for each documentation page ?root : `string` The root url of the generated documentation within the website ?qualify : `bool` qualify the output set by collection name, e.g. `reference/FSharp.Core/...` ?libDirs : `string list` Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments ?otherFlags : `string list` Additional flags that are passed to the F# compiler to specify references explicitly etc. ?urlRangeHighlight : `Uri -> int -> int -> string` A function that can be used to override the default way of generating GitHub links ?onError : `string -> unit` Returns: `ApiDocModel * ApiDocsSearchIndexEntry[]`
`ApiDocs.GenerateModel(inputs, collectionName, substitutions, ?qualify, ?libDirs, ?otherFlags, ?root, ?urlRangeHighlight, ?onError, ?extension)` Full Usage: `ApiDocs.GenerateModel(inputs, collectionName, substitutions, ?qualify, ?libDirs, ?otherFlags, ?root, ?urlRangeHighlight, ?onError, ?extension)` Parameters: inputs : `ApiDocInput list` - the components to generate documentation for collectionName : `string` - the overall collection name substitutions : `Substitutions` - the substitutions to use in content and templates ?qualify : `bool` - qualify the output set by collection name, e.g. `reference/FSharp.Core/...` ?libDirs : `string list` - Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments ?otherFlags : `string list` - Additional flags that are passed to the F# compiler (you can use this if you want to specify references explicitly etc.) ?root : `string` - The root url of the generated documentation within the website ?urlRangeHighlight : `Uri -> int -> int -> string` - A function that can be used to override the default way of generating GitHub links ?onError : `string -> unit` - ?extension : `ApiDocFileExtensions` - The extensions used for files and URLs Returns: `ApiDocModel`	Generates a documentation model for the assemblies specified by the `inputs` parameter inputs : `ApiDocInput list` the components to generate documentation for collectionName : `string` the overall collection name substitutions : `Substitutions` the substitutions to use in content and templates ?qualify : `bool` qualify the output set by collection name, e.g. `reference/FSharp.Core/...` ?libDirs : `string list` Use this to specify additional paths where referenced DLL files can be found when formatting code snippets inside Markdown comments ?otherFlags : `string list` Additional flags that are passed to the F# compiler (you can use this if you want to specify references explicitly etc.) ?root : `string` The root url of the generated documentation within the website ?urlRangeHighlight : `Uri -> int -> int -> string` A function that can be used to override the default way of generating GitHub links ?onError : `string -> unit` ?extension : `ApiDocFileExtensions` The extensions used for files and URLs Returns: `ApiDocModel`
`ApiDocs.SearchIndexEntriesForModel(model)` Full Usage: `ApiDocs.SearchIndexEntriesForModel(model)` Parameters: model : `ApiDocModel` - the model for documentation Returns: `ApiDocsSearchIndexEntry[]`	Generates the search index from the given documentation model model : `ApiDocModel` the model for documentation Returns: `ApiDocsSearchIndexEntry[]`