FuncInfo object

Table of Contents Constructors FuncInfo Methods constructor get_name get_summary get_params get_returnType get_returnDesc toString

Constructors

FuncInfo

NAME
    FuncInfo

SYNOPSIS
    Initializes a new FuncInfo object with the specified function
    information.

SYNTAX
    <cbc.parse.FuncInfo> FuncInfo(Object info)

PARAMETERS
    -info <Object>
        An object with function information. Valid properties are:

            • String name: The name of the function

            • [String summary = null]: Function summary

            • [Array params = []]: A list of ParamInfo objects

            • [String returnType = null]: Function return type

            • [String returnDesc = null]: Description of the returned value

OUTPUTS
    <cbc.parse.FuncInfo>
        The initialized FuncInfo object.

Methods

constructor

NAME
    FuncInfo

SYNOPSIS
    Initializes a new FuncInfo object with the specified function
    information.

SYNTAX
    <cbc.parse.FuncInfo> FuncInfo(Object info)

PARAMETERS
    -info <Object>
        An object with function information. Valid properties are:

            • String name: The name of the function

            • [String summary = null]: Function summary

            • [Array params = []]: A list of ParamInfo objects

            • [String returnType = null]: Function return type

            • [String returnDesc = null]: Description of the returned value

OUTPUTS
    <cbc.parse.FuncInfo>
        The initialized FuncInfo object.

get_name

NAME
    get_name

SYNOPSIS
    Get the name of the function.

SYNTAX
    <String> get_name()

PARAMETERS


OUTPUTS
    <String>
        The name of the function.

get_summary

NAME
    get_summary

SYNOPSIS
    Get the function's documentation summary.

SYNTAX
    <String> get_summary()

PARAMETERS


OUTPUTS
    <String>
        The function's documentation summary.

get_params

NAME
    get_params

SYNOPSIS
    Get the parameter information list.

SYNTAX
    <Array> get_params()

PARAMETERS


OUTPUTS
    <Array>
        The parameter information list.

get_returnType

NAME
    get_returnType

SYNOPSIS
    Get the type the function returns.

SYNTAX
    <String> get_returnType()

PARAMETERS


OUTPUTS
    <String>
        The type the function returns.

get_returnDesc

NAME
    get_returnDesc

SYNOPSIS
    Get the function's return description.

SYNTAX
    <String> get_returnDesc()

PARAMETERS


OUTPUTS
    <String>
        The function's return description.

toString

NAME
    toString

SYNOPSIS
    Returns API help for the function represented by this
    FuncInfo object in a PowerShell Cmdlet help kind of way.

SYNTAX
    <String> toString()

PARAMETERS


OUTPUTS
    <String>
        API help for the function represented by this FuncInfo
        object.