Template:API/Methods/doc

Function
This template can be used to generate documentation for API documentation pages.

Parameters

 * - The access modifier of the method.
 * - The return type of the method. Leave empty for declaring constructors.
 * - The identifier of the method.
 * - Additional method signature keywords that would be in place between the type and modifier.
 * - A description of the method.
 * - A description of what kind of result is returned by the method.

Parameter Parameters
These are generated by Lua code when a full trio of the same number is present. There are obvious ways to break this, so just use integers greater than 0 for X. Fail-safe condition is to not render, or to throw an error.


 * - The identifier of the Xth parameter that would appear in the method's signature.
 * - The return type of the Xth parameter that would appear in the method's signature.
 * - A description of the Xth parameter that would appear in the method's signature.

Styling

 * - The number of header characters desired for the heading. Default is 4. Can be used for no heading.
 * - The programming language used for the method. When in doubt, it's likely C#.

Storage

 * - Whether the data in the template should be stored or not. TRUE to store, no otherwise. Default value is "TRUE".