Header menu logo FSharp.Formatting

ApiDocNamespace Type

Represents a namespace integrated with its associated documentation

Constructors

Constructor Description

ApiDocNamespace(name, modifiers, substitutions, nsdocs)

Full Usage: ApiDocNamespace(name, modifiers, substitutions, nsdocs)

Parameters:
Returns: ApiDocNamespace
name : string
modifiers : ApiDocEntity list
substitutions : Substitutions
nsdocs : ApiDocComment option
Returns: ApiDocNamespace

Instance members

Instance member Description

this.Entities

Full Usage: this.Entities

Returns: ApiDocEntity list

All modules in the namespace

Returns: ApiDocEntity list

this.Name

Full Usage: this.Name

Returns: string

The name of the namespace

Returns: string

this.NamespaceDocs

Full Usage: this.NamespaceDocs

Returns: ApiDocComment option

The summary text for the namespace

Returns: ApiDocComment option

this.OutputFile

Full Usage: this.OutputFile

Parameters:
    collectionName : string
    qualify : bool
    extension : string

Returns: string

The name of the file generated for this entity

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

this.Substitutions

Full Usage: this.Substitutions

Returns: Substitutions

The substitution substitutions active for generating thist content

Returns: Substitutions

this.Url

Full Usage: this.Url

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

Returns: string

The URL of the best link documentation for the item (without the http://site.io/reference)

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

this.UrlBaseName

Full Usage: this.UrlBaseName

Returns: string

The base name for the generated file

Returns: string

this.UrlHash

Full Usage: this.UrlHash

Returns: string

The hash label for the URL with the overall namespaces file

Returns: string

Type something to start searching.