|Kedyn Macedonio 7b32c17ae3 removed description on the same line as @const||4 weeks ago|
|i18n||1 month ago|
|LICENSE||10 months ago|
|README.md||1 month ago|
|SimpleDocumentation.mRC||4 weeks ago|
|docs.md||4 weeks ago|
This is a tool that generates documentation based on comments on an mSL file.
The main file is called
SimpleDocumentation.mRC and it is located in the root folder. All you must do is load it to mIRC.
The main command is
document <file>, where
<file> is the msl file to be documented.
All of your documentation comments must start with
/**. And the documentation must start with an asterics and a space. The documentation must follow the following patern:
/** * My command description. * @command /myCommand * @switch a some modification * @param test some parameter * @global */
/** * My identifier description. * @identifier /myIdentifier * @param test some parameter * @prop notest some property * @global */
If you would like to contribute to the project I ask that you use variable_names with all lower case and all aliases with camelCase. All new aliases and/or modifications must be documented.
This project is made available under the MIT License.