FSharp.Formatting


ApiDocModel Type

Represents a set of assemblies integrated with their associated documentation

Instance members

Instance member Description

this.Collection

Full Usage: this.Collection

Returns: ApiDocCollection

The full list of all entities

Returns: ApiDocCollection

this.EntityInfos

Full Usage: this.EntityInfos

Returns: ApiDocEntityInfo list

The full list of all entities

Returns: ApiDocEntityInfo list

this.FileExtensions

Full Usage: this.FileExtensions

Returns: ApiDocFileExtensions

Specifies file extensions to use in files and URLs

Returns: ApiDocFileExtensions

this.IndexFileUrl

Full Usage: this.IndexFileUrl

Parameters:
    root : string
    collectionName : string
    qualify : bool
    extension : string

Returns: string

URL of the 'index.html' for the reference documentation for the model

root : string
collectionName : string
qualify : bool
extension : string
Returns: string

this.IndexOutputFile

Full Usage: this.IndexOutputFile

Parameters:
    collectionName : string
    qualify : bool
    extension : string

Returns: string

URL of the 'index.html' for the reference documentation for the model

collectionName : string
qualify : bool
extension : string
Returns: string

this.Qualify

Full Usage: this.Qualify

Returns: bool

Indicates if each collection is being qualified by its collection name, e.g. 'reference/FSharp.Core'

Returns: bool

this.Root

Full Usage: this.Root

Returns: string

The root URL for the entire generation, normally '/'

Returns: string

this.Substitutions

Full Usage: this.Substitutions

Returns: Substitutions

The substitutions. Different substitutions can also be used for each specific input

Returns: Substitutions