Libraries.Language.Compile.Symbol.Documentation Documentation
Inherits from: Libraries.Language.Compile.Location, Libraries.Language.Object
Summary
Variable Summary Table
| Variables | Description |
|---|---|
| text EXAMPLE | |
| text PARAMETER | |
| text RETURNS | |
| text AUTHOR |
Actions Summary Table
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.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
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.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetAuthor()
Return
text
GetColumnNumber()
Return
integer
GetColumnNumberEnd()
Return
integer
GetDescription()
Return
text
GetExample()
Return
text
GetFile()
Return
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()Return
integer: The integer hash code of the object.
GetHeaderAsWeb()
result = result + "
" + GetDescription() + "
"Return
text:
GetHeaderDivision()
Return
GetIndex()
Return
integer
GetIndexEnd()
Return
integer
GetLineNumber()
Return
integer
GetLineNumberEnd()
Return
integer
GetParameterDescription(text name)
Parameters
Return
text
GetReturns()
Return
text
GetShortDescription()
This action returns the first sentence from the description.
Return
text:
HasParameter(text name)
Parameters
Return
boolean
ParseDocumentation(text docs)
Parameters
SetColumnNumber(integer column)
Parameters
SetColumnNumberEnd(integer column)
Parameters
SetFile(Libraries.System.File file)
Parameters
SetIndex(integer index)
Parameters
SetIndexEnd(integer index)
Parameters
SetLineNumber(integer line)
Parameters
SetLineNumberEnd(integer line)
Parameters
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: