Inspect.Documentation

From Riftui Wiki

Jump to: navigation, search

Provide documentation on items in the addon environment. Called with no parameters, it returns a table listing all documentation. Can provide both human-readable and computer-readable documentation.

Contents

Signature

documentables = Inspect.Documentation()   -- table <- void
documentation = Inspect.Documentation(item)   -- string <- variant
documentation = Inspect.Documentation(item, parseable = false)   -- string <- variant, boolean
documentationTable = Inspect.Documentation(item, parseable = true)   -- table <- variant, boolean

Parameters

item: The item to get documentation on. May be either the item itself or a string identifier. (variant)
parseable: Whether to return in a computer-readable format, as opposed to the normal human-readable format (boolean).

Return Value

documentables: List of all items that documentation can be retrieved for. In {["itemname"] = true} format (table).
documentation: Documentation for the requested item (string).
documentationTable: Computer-readable documentation for the requested item. Format may change without warning (table).

Returned Members

none

Personal tools
Namespaces
Variants
Actions
Menu
Wiki
Toolbox