RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://fsprojects.github.io/FSharp.Formatting/reference/fsharp-formatting-apidocs-apidocs.html below:

ApiDocs (FSharp.Formatting) | FSharp.Formatting


   ApiDocs.GenerateHtml(inputs, output, collectionName, substitutions, ?template, ?root, ?qualify, ?libDirs, ?otherFlags, ?urlRangeHighlight, ?onError)

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)

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[]

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

Generates the search index from the given documentation model

model : ApiDocModel: the model for documentation

Returns: ApiDocsSearchIndexEntry[]

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4