Vogon

Supported platforms:

Available since: 2042.11
Inherits from: Cryptography

Description

This is just a test of docs gen from the create-wiki-pages.lua script in the plugins folder of the Gideros repository using the included vogon.wiki.lua file. From a Lua description file, multiple pages are created which can then be relatively easily copied and pasted into new pages. Run create-wiki-pages.lua without arguments for instructions.

Feel free to experiment with vogon.wiki.lua and publish revisions of the Vogon API, which should however remain decidedly non-Vogon in brevity. Maybe keep some reference to the files involved/the true purpose of the mission too.

Examples

Standard use of a Vogon.

require "Vogon"
local vogon = Vogon.new()
local poetry = vogon:writePoetry(topic)
local number_of_deaths = vogon:recitePoetry()

Methods Vogon.new Create a new Vogon Vogon:writePoetry Creates abnormally long poem. Vogon:recitePoetry Recites the third worst poetry in the known universe.

Events Vogon.Vogon.IMMINENT_DESTRUCTION Vogon.Vogon.POST_DESTRUCTION Constants Vogon.Vogon.STATUS_SIGN_POSTED Vogon.Vogon.STATUS_DESTRUCTION_APPROVED