Libraries.Language.Compile.Documentation.DocumentationGenerator

Libraries.Language.Compile.Documentation.DocumentationGenerator Documentation

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

Actions	Description
AddDefaultHeaders(Libraries.Web.Page.WebPage page)	ignore the default package
Compare(Libraries.Language.Object object)	This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)	This action determines if two objects are equal based on their hash code values.
GenerateKeywords()	Add Responsive Stylesheets
GetFooter()	add the meta-data character set
GetHashCode()	This action gets the hash code for an object.
GetMetaDescription()	Add the navigation bar
GetRunFolder()
SetRunFolder(Libraries.System.File file)
Write(Libraries.Language.Compile.Library library, Libraries.Containers.HashTable<text:Libraries.Language.Compile.Translate.ClassOpcode> opcodeHash, boolean includeStandardLibrary)
Write(Libraries.Language.Compile.Library library)
WriteIndexPage(Libraries.Language.Compile.Symbol.SymbolTable symbolTable)	navigation, footer)

Actions Documentation

AddDefaultHeaders(Libraries.Web.Page.WebPage page)

ignore the default package

Parameters

Libraries.Web.Page.WebPage

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.

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.

GenerateKeywords()

Add Responsive Stylesheets

Return

Libraries.Web.Page.MetaData:

GetFooter()

add the meta-data character set

Return

Libraries.Web.Page.Footer:

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.

GetMetaDescription()

Add the navigation bar

Return

text:

GetRunFolder()

Return

Libraries.System.File

SetRunFolder(Libraries.System.File file)

Parameters

Libraries.System.File

Write(Libraries.Language.Compile.Library library, Libraries.Containers.HashTable<text:Libraries.Language.Compile.Translate.ClassOpcode> opcodeHash, boolean includeStandardLibrary)