Logo Xantham

TsComment Type

DU of TS comment tag types.

Union cases

Union case Description

DefaultValue string

Full Usage: DefaultValue string

Parameters:
    Item : string

Item : string

Deprecated string option

Full Usage: Deprecated string option

Parameters:
    Item : string option

Item : string option

Example string

Full Usage: Example string

Parameters:
    Item : string

Item : string

Param(name, content)

Full Usage: Param(name, content)

Parameters:
    name : string
    content : string option

name : string
content : string option

Remarks string

Full Usage: Remarks string

Parameters:
    Item : string

Item : string

Returns string

Full Usage: Returns string

Parameters:
    Item : string

Item : string

Summary string list

Full Usage: Summary string list

Parameters:
    Item : string list

Item : string list

Throws string

Full Usage: Throws string

Parameters:
    Item : string

Item : string

TypeParam(typeName, content)

Full Usage: TypeParam(typeName, content)

Parameters:
    typeName : string
    content : string option

typeName : string
content : string option

Instance members

Instance member Description

this.IsDefaultValue

Full Usage: this.IsDefaultValue

Returns: bool
Returns: bool

this.IsDeprecated

Full Usage: this.IsDeprecated

Returns: bool
Returns: bool

this.IsExample

Full Usage: this.IsExample

Returns: bool
Returns: bool

this.IsParam

Full Usage: this.IsParam

Returns: bool
Returns: bool

this.IsRemarks

Full Usage: this.IsRemarks

Returns: bool
Returns: bool

this.IsReturns

Full Usage: this.IsReturns

Returns: bool
Returns: bool

this.IsSummary

Full Usage: this.IsSummary

Returns: bool
Returns: bool

this.IsThrows

Full Usage: this.IsThrows

Returns: bool
Returns: bool

this.IsTypeParam

Full Usage: this.IsTypeParam

Returns: bool
Returns: bool

Type something to start searching.