Header menu logo Fabulous.AST

XmlDocsModifiers Type

Static members

Static member Description

XmlDocsModifiers.exceptionInfo (this, exceptionInfo, desc)

Full Usage: XmlDocsModifiers.exceptionInfo (this, exceptionInfo, desc)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    exceptionInfo : string - Exception type.
    desc : string - Exception description.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds exception information to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

exceptionInfo : string

Exception type.

desc : string

Exception description.

Returns: WidgetBuilder<XmlDocNode>

XmlDocsModifiers.exceptionInfo (this, exceptionInfo)

Full Usage: XmlDocsModifiers.exceptionInfo (this, exceptionInfo)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    exceptionInfo : (string * string) list - List of exception type and description pairs.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds exception information to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

exceptionInfo : (string * string) list

List of exception type and description pairs.

Returns: WidgetBuilder<XmlDocNode>

XmlDocsModifiers.parameters (this, returnInfo, desc)

Full Usage: XmlDocsModifiers.parameters (this, returnInfo, desc)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    returnInfo : string - Parameter name.
    desc : string - Parameter description.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds a single parameter documentation to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

returnInfo : string

Parameter name.

desc : string

Parameter description.

Returns: WidgetBuilder<XmlDocNode>

XmlDocsModifiers.parameters (this, returnInfo)

Full Usage: XmlDocsModifiers.parameters (this, returnInfo)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    returnInfo : string * string - Parameter name and description pair.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds a single parameter documentation to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

returnInfo : string * string

Parameter name and description pair.

Returns: WidgetBuilder<XmlDocNode>

XmlDocsModifiers.parameters (this, parameters)

Full Usage: XmlDocsModifiers.parameters (this, parameters)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    parameters : (string * string) list - List of parameter name and description pairs.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds parameter documentation to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

parameters : (string * string) list

List of parameter name and description pairs.

Returns: WidgetBuilder<XmlDocNode>

XmlDocsModifiers.returnInfo (this, returnInfo)

Full Usage: XmlDocsModifiers.returnInfo (this, returnInfo)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    returnInfo : string - Return value description.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds return value documentation to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

returnInfo : string

Return value description.

Returns: WidgetBuilder<XmlDocNode>

XmlDocsModifiers.returnInfo (this, returnInfo)

Full Usage: XmlDocsModifiers.returnInfo (this, returnInfo)

Parameters:
    this : WidgetBuilder<XmlDocNode> - Current XML documentation widget.
    returnInfo : string list - List of return value description lines.

Returns: WidgetBuilder<XmlDocNode>
Modifiers: inline

Adds return value documentation to XML documentation.

this : WidgetBuilder<XmlDocNode>

Current XML documentation widget.

returnInfo : string list

List of return value description lines.

Returns: WidgetBuilder<XmlDocNode>

Type something to start searching.