The AutoDoc system creates documentation files from the information provided from Luxinia and the modulekernel. The AutoDoc class provides a system that can be extended to create help files that fits your use.
For creating your own documentation, you have to set up a template table. This table may contain string, tables and functions.
Creates a string from a table that was passed that acts as a template. The table may contain functions, tables and strings.
The table is converted to a string that represents the final document. The table is therefore iterated from 1 to n, where n is the number of number-indexed values in the table. That means that you can use any kind of keys for storing additional information that you need during the process. In each iteration,
The template may contain strings that are formated like "%file=abc%". The string "abc" is then used as a key in the table that is additionally returned. Per default, all output is saved to the key "main" in the table, as long as no such instruction is used. You can use the created table with all the outputstrings to write it to a file or another structure.
returns a function that can be used in the template system.
returns a function that returns a string of a hierarchical listing of all class in a list form. If api is true, the apihierarchy is used, if its false or not used, the modulehierarchy is used.
The passed string is used for each element in the list, the sublistfmt is used for childs in the hierarchy.
similiar to createDoc, except that the output is written to files in a given output directory.