Module pure.moddoc
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.
Info:
- Copyright: [mailto:jeblad@gmail.com]
- License: [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons: Attribution-ShareAlike 3.0 Unported] (CC BY-SA 3.0)
- Author: [[User:Jeblad]]
Functions
| Frag:_init () | Initialiser for the Frag class |
| Frag.weightOfClass () | Weight of the given class viewed as a possible Frag instance |
| Frag.weightOfClassDescription () | Weight of the given description viewed as a possible Frag instance |
| Frag.weightOfClassSignature () | Weight of the given signature viewed as a possible Frag instance |
| Frag:renderClass () | Render method for the class member field |
| Frag:renderWeight () | Render method for the weight member field |
| Frag:renderSummary () | Render method for the summary member field |
| Frag:renderDescription () | Render method for the description member field |
| Frag:render () | Render method for the total Frag structure |
| Var:_init () | Initialiser for the Var class |
| Var.weightOfClass () | Weight of the given class viewed as a possible Var instance |
| Var.weightOfClassDescription () | Weight of the given description viewed as a possible Var instance |
| Var.weightOfClassSignature () | Weight of the given signature viewed as a possible Var instance |
| Var:render () | Render method for the total Var structure |
| Mod:_init () | Initialiser for the Mod class |
| Mod.weightOfClass () | Weight of the given class viewed as a possible Frag instance |
| Mod.weightOfClassDescription () | Weight of the given description viewed as a possible Mod instance |
| Mod.weightOfClassSignature () | Weight of the given signature viewed as a possible Mod instance |
| Mod:render () | Render method for the total Mod structure |
| Ret:_init () | Initialiser for the ret class |
| Ret.weightOfClass () | Weight of the given class viewed as a possible Ret instance |
| Ret.weightOfClassDescription () | Weight of the given description viewed as a possible ret instance |
| Ret.weightOfClassSignature () | Weight of the given signature viewed as a possible Ret instance |
| Ret:render () | Render method for the total Ret structure |
| Func:_init () | Initialiser for the Func class |
| Func.weightOfClass () | Weight of the given class viewed as a possible Func instance |
| Func.weightOfClassDescription () | Weight of the given description viewed as a possible Func instance |
| Func.weightOfClassSignature () | Weight of the given signature viewed as a possible Func instance |
| Func:render () | Render method for the total Func structure |
| luadoc.build () | Invokable method to build a document |
Functions
- Frag:_init ()
-
Initialiser for the Frag class
Parameters:
- t table holding data used during initialization
- Frag.weightOfClass ()
-
Weight of the given class viewed as a possible Frag instance
Parameters:
- t table holding data used during initialization
- Frag.weightOfClassDescription ()
-
Weight of the given description viewed as a possible Frag instance
Parameters:
- s string holding a code snippet
- Frag.weightOfClassSignature ()
-
Weight of the given signature viewed as a possible Frag instance
Parameters:
- s string holding a code snippet
- Frag:renderClass ()
-
Render method for the class member field
Parameters:
- t table for optional data used while rendering
- Frag:renderWeight ()
-
Render method for the weight member field
Parameters:
- t table for optional data used while rendering
- Frag:renderSummary ()
-
Render method for the summary member field
Parameters:
- t table for optional data used while rendering
- Frag:renderDescription ()
-
Render method for the description member field
Parameters:
- t table for optional data used while rendering
- Frag:render ()
-
Render method for the total Frag structure
Parameters:
- t table for optional data used while rendering
Returns:
table the extended parent - Var:_init ()
-
Initialiser for the Var class
Parameters:
- t table holding data used during initialization
- Var.weightOfClass ()
-
Weight of the given class viewed as a possible Var instance
Parameters:
- t table holding data used during initialization
- Var.weightOfClassDescription ()
-
Weight of the given description viewed as a possible Var instance
Parameters:
- t table holding data used during initialization
- Var.weightOfClassSignature ()
-
Weight of the given signature viewed as a possible Var instance
Parameters:
- s string holding a code snippet
- Var:render ()
-
Render method for the total Var structure
Parameters:
- t table for optional data used while rendering
Returns:
table the extended parent - Mod:_init ()
-
Initialiser for the Mod class
Parameters:
- t table holding data used during initialization
- Mod.weightOfClass ()
-
Weight of the given class viewed as a possible Frag instance
Parameters:
- t table holding data used during initialization
- Mod.weightOfClassDescription ()
-
Weight of the given description viewed as a possible Mod instance
Parameters:
- t table holding data used during initialization
- Mod.weightOfClassSignature ()
-
Weight of the given signature viewed as a possible Mod instance
Parameters:
- s string holding a code snippet
- Mod:render ()
-
Render method for the total Mod structure
Parameters:
- t table for optional data used while rendering
Returns:
table the extended parent - Ret:_init ()
-
Initialiser for the ret class
Parameters:
- t table holding data used during initialization
- Ret.weightOfClass ()
-
Weight of the given class viewed as a possible Ret instance
Parameters:
- t table holding data used during initialization
- Ret.weightOfClassDescription ()
-
Weight of the given description viewed as a possible ret instance
Parameters:
- t table holding data used during initialization
- Ret.weightOfClassSignature ()
-
Weight of the given signature viewed as a possible Ret instance
Parameters:
- s string holding a code snippet
- Ret:render ()
-
Render method for the total Ret structure
Parameters:
- t table for optional data used while rendering
Returns:
table the extended parent - Func:_init ()
-
Initialiser for the Func class
Parameters:
- t table holding data used during initialization
- Func.weightOfClass ()
-
Weight of the given class viewed as a possible Func instance
Parameters:
- t table holding data used during initialization
- Func.weightOfClassDescription ()
-
Weight of the given description viewed as a possible Func instance
Parameters:
- t table holding data used during initialization
- Func.weightOfClassSignature ()
-
Weight of the given signature viewed as a possible Func instance
Parameters:
- s string holding a code snippet
- Func:render ()
-
Render method for the total Func structure
Parameters:
- parent table reference to the containing element
- t table for optional data used while rendering
Returns:
- table the parent make the method chainable
- table the extended parent
- luadoc.build ()
-
Invokable method to build a document
Parameters:
- frame table for contextual information
Returns:
string for display on a rendered page