Libraries.Language.Compile.Symbol.Documentation Documentation

Inherits from: Libraries.Language.Compile.Location, Libraries.Language.Object

Variables Table

VariablesDescription
text RETURNS
text PARAMETER
text AUTHOR
text EXAMPLE

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

CreateLocationCopy()

This action is a helper action to get copies of the location.

Return

Libraries.Language.Compile.Location:

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetAuthor()

Return

text

GetColumnNumber()

Return

integer

GetColumnNumberEnd()

Return

integer

GetDescription()

Return

text

GetExample()

Return

text

GetFile()

Return

Libraries.System.File

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetHeaderAsWeb()

Return

text

GetHeaderDivision()

Return

Libraries.Web.Page.Division

GetIndex()

Return

integer

GetIndexEnd()

Return

integer

GetLineNumber()

Return

integer

GetLineNumberEnd()

Return

integer

GetParameterDescription(text name)

Parameters

  • text name

Return

text

GetReturns()

Return

text

GetShortDescription()

This action returns the first sentence from the description.

Return

text:

HasParameter(text name)

Parameters

  • text name

Return

boolean

ParseDocumentation(text docs)

Parameters

  • text docs

SetColumnNumber(integer column)

Parameters

  • integer column

SetColumnNumberEnd(integer column)

Parameters

  • integer column

SetFile(Libraries.System.File file)

Parameters

SetIndex(integer index)

Parameters

  • integer index

SetIndexEnd(integer index)

Parameters

  • integer index

SetLineNumber(integer line)

Parameters

  • integer line

SetLineNumberEnd(integer line)

Parameters

  • integer line

SetLocation(Libraries.Language.Compile.Location location)

This action uses the location and resets the current error's data.

Parameters

ToText()

This action is a helper action to get copies of the location.

Return

text: