cmp.lua
Composition rules for generating the output files.
Description:
Definitions
section_names
=
Names of document sections.
types
=
Table of expected Lua types to be bolded on the output.
Functions
anchor
(f)
Build a function that will create an anchor with a filter.
file_footer
(field_value)
Print the file footer.
file_header
(field_value)
Print the file header.
first_rest
(str)
Split the string in two parts: the first word and the rest of
the string.
MakeIndex
(source)
MakeTitle
(source)
Write
(field_value)
Write_each
(label)
Build a Write function that generate the output for a table.
Definitions
section_names
=
Names of document sections.
types
=
Table of expected Lua types to be bolded on the output.
- See also
- first_rest
Functions
anchor
(f)
Build a function that will create an anchor with a filter.
- Parameters
f | Function that will filter the name of the anchor |
Return Value: Function that will be used to create an anchor.
file_footer
(field_value)
file_header
(field_value)
first_rest
(str)
Split the string in two parts: the first word and the rest of
the string.
- Parameters
str | String to be processed |
Return Value: Two strings: the first word and the rest of the original
string.
MakeIndex
(source)
- Parameters
source | Table with source data (not used) |
MakeTitle
(source)
- Parameters
source | Table with source data |
Write
(field_value)
- Parameters
field_value | Object to be printed |
Write_each
(label)
Build a Write function that generate the output for a table.
- Parameters
label | String label used by the function |
Return Value: Function that "prints" all table's fields and values.
This file was automatically generated by LuaDoc in 14 of August of 2002.