Module talk:Sandbox/Jeblad/LuaDoc

Example itself

{{#invoke:Sandbox/Jeblad/LuaDoc|build|Module:Sandbox/Jeblad/LuaDoc}} prints:

module

75

Format documentation of a module and make it linkable

The module makes some assumptions about the layout, basically the same as JavaDoc and LuaDoc, but does not follow those examples strictly. Especially, it makes no attempt to do a deeper analysis of the provided code.

module

75

Registry for fragment types

module

75

Registry for access points

module

155

Table acting as a baseclass for fragments

function

0

Initialiser for the Frag class

function

50

Weight of the given class viewed as a possible Frag instance

function

50

Weight of the given description viewed as a possible Frag instance

function

50

Weight of the given signature viewed as a possible Frag instance

function

50

Render method for the class member field

function

50

Render method for the weight member field

function

50

Render method for the summary member field

function

50

Render method for the description member field

function

50

Render method for the total Frag structure

module

155

Table acting as a subclass for varables

function

0

Initialiser for the Var class

function

50

Weight of the given class viewed as a possible Var instance

function

50

Weight of the given description viewed as a possible Var instance

function

50

Weight of the given signature viewed as a possible Var instance

function

50

Render method for the total Var structure

module

115

Table acting as a subclass for modules

function

0

Initialiser for the Mod class

function

50

Weight of the given class viewed as a possible Frag instance

function

50

Weight of the given description viewed as a possible Mod instance

function

50

Weight of the given signature viewed as a possible Mod instance

function

50

Render method for the total Mod structure

module

115

Table acting as a subclass for modules

function

0

Initialiser for the ret class

function

50

Weight of the given class viewed as a possible Ret instance

function

50

Weight of the given description viewed as a possible ret instance

function

50

Weight of the given signature viewed as a possible Ret instance

function

50

Render method for the total Ret structure

module

155

Table acting as a subclass for functions

function

0

Initialiser for the Func class

function

50

Weight of the given class viewed as a possible Func instance

function

50

Weight of the given description viewed as a possible Func instance

function

50

Weight of the given signature viewed as a possible Func instance

function

50

Render method for the total Func structure

function

50

Load page identified by text and namespace

function

50

Create a fragment according to a best guess

function

75

Strip provided code for block comments

function

50

Split provided code in fragments

@x-access public this should be public if everything works out

function

50

Parse provided code

@x-access public this will be private if everything works out

function

50

Invokable method to build a document

module

25

Final return of the provided module