moondoc v1.1.0

moondoc

Lua API documentation generator

Generates a single .html file in the style of e.g. documentation, but for Lua instead of Javascript.

This tool was originally written to assist with documenting WorldEditAdditions (direct link to source code), as the output of LuaDoc didn't look the way I wanted and didn't handle the dofile()s we're forced to use across the codebase.

See also LDoc.

Yes, I know this tool is written in Javascript and not Lua, but Lua doesn't come with batteries included so writing a Lua documentation generator in Lua would have been a painful process....

Documentation blocks

Moondoc functions on documentation blocks in a similar format to that of JSDoc. Here's an example block:

--- Subtracts the specified vectors or numbers together.
-- Returns the result as a new vector.
-- If 1 of the inputs is a number and the other a vector, then the number will
-- be subtracted to each of the components of the vector.
-- @param	a	Vector3|number	The first item to subtract.
-- @param	a	Vector3|number	The second item to subtract.
-- @returns	Vector3				The result as a new Vector3 object.

Moondoc documentation blocks always start with a triple dash, and end on the next non-comment line. Each block is made up of 3 parts:

1. First line: The short summary of what the thing does
2. Description: The next lines are considered the extended description of the thing
3. At rules: Lastly, lines beginning with an @ are at rules. For example, @param describes an argument of a function. At rules may have text flowing onto multiple lines.

Documentation blocks should be used in the following places:

Before functions:

--- Determines if this vector is contained within the region defined by the given vectors.
-- A longer description goes here.
-- @param	a		Vector3		The target vector to check.
-- @param	pos1	Vector3		pos1 of the defined region.
-- More description text for pos1
-- @param	pos2	Vector3		pos2 of the defined region.
-- @return	boolean	Whether the given target is contained within the defined worldedit region.
-- This is the second line of the description for @return.
function Vector3.is_contained(target, pos1, pos2)
	-- Function code here
end

!IMPORTANT Documentation blocks defining a function must be directly before a function, with no intermediate or black lines in between.

At the top of each file with @namespace or @class:

--- A 3-dimensional vector.
-- @class	worldeditadditions_core.Vector3
local Vector3 = {}

-- .....

--- Functions for parsing things.
-- @namespace worldeditadditions_core.parse
worldeditadditions_core.parse = {
	-- .....
}

-- ........

To document events*:

--- A new position has been set in a player's list at a specific position.
-- @event	set
-- @format	{ player_name: string, i: number, pos: Vector3 }
-- @example
-- {
-- 	player_name = "some_player_name",
-- 	i = 3,
-- 	pos = <Vector3> { x = 456, y = 64, z = 9045 }
-- }

• See EventEmitter.lua licence: MPL-2.0 for an example EventEmitter / eventing system implementation

At rules

The following at rules exist:

@param

Describes an argument to a function. Values are whitespace separated, in the following format:

-- @param <variable_name>	<data_type>	<description>

• <variable_name>: The name of the argument. This must match the function definition.
• <data_type>: The data type of the argument. This can be a built-in type (e.g. number, string, etc), or some custom class name (e.g. Vector3).
• <description>: Describe the purpose of the argument here! Don't forget to include any non-obvious things about the behaviour and format of the argument too. Descriptions can flow over multiple lines to really describe something in detail.

@return / @returns

Describes the return value(s) of a function. Values are whitespace separated, in the following format:

-- @returns	<data_type>	<description>

• <data_type>: The data type of the item being returned. If multiple items are returned, separate them with commas.
• <description>: A description of the return value.

@namespace

Specifies the namespace of the rest of the file. Any description lines will be used as a description for the namespace defined. It takes the following form:

-- @namespace <namespace>

• <namespace>: The namespace, separated by dots. For example, foo.bar or worldeditadditions.noise.engines.

@class

Identical to @namespace, but defines a 'class' instead (the author is aware that Lua only has metatables and not proper classes). This is a cosmetic change in the icon used to identify the namespace in the documentation.

@module

Identical to @namespace in that it sets the namespace of a file, but does not add to the generated documentation. Can be useful if e.g. you have a main @namespace definition in one file for a given namespace, but then a some other satellite files that also need to be part of that namespace but you don't want to add a description that will appear in the generated documentation.

!IMPORTANT All namespaces MUST have at least one @namespace definition somewhere in the codebase.

@internal

Specifies that a function is internal and hence subject to change. Displays an a icon (🔑) next to the function to indicate this.

@event

Indicates the current documentation block is documenting an event.

The author is aware that Lua does not have a native eventing system. It is expected that authors will implement / have implemented their own eventing system.

This directive takes a single value:

-- @event <event_name>

• <event_name>: The name of the event being documented.

Optionally @format can be used to describe the format of any argument passed to callback functions.

@format

Describes the format of argument(s) passed to callback functions when an event is called. It has the following format:

-- @format <value_description>

• <value_description>: A description of the format of the argument. It is recommended but not required that a single object is always passed to event callback functions, and the format thereof documented here in the format { parameter: type, .... }, where parameter is the name of each field, and type is the type of the value associated therewith (e.g. string, boolean, SomeClass, etc).

@value

This directive is currently not fully implemented.

Indicates that a single value is being documented rather than a function, class, or event. Takes a single value:

-- @value <type>

• <type>: Describes the type of the value being documented - for example number, FooClass, etc.

System Requirements

• Node.js

Getting started

TODO Fill this out.

TODO DO NOT FORGET TO RUN ESBUILD BEFORE MAKING A RELEASE