This is a tool that generates documentation based on comments on an mSL file.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kedyn Macedonio 7b32c17ae3 removed description on the same line as @const 4 weeks ago
i18n minor fixes, added language, updated readme 1 month ago
LICENSE Update license and readme 10 months ago
README.md minor fixes, added language, updated readme 1 month ago
SimpleDocumentation.mRC removed description on the same line as @const 4 weeks ago
docs.md removed description on the same line as @const 4 weeks ago

README.md

SimpleDocumentation

This is a tool that generates documentation based on comments on an mSL file.

Dependencies

mIRC v7.55+

Installation

The main file is called SimpleDocumentation.mRC and it is located in the root folder. All you must do is load it to mIRC.

How to use it

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
*/

For more @tags read docs file.

Contributing & Development Process

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.

Limitations

You must follow the specified pattern for commands and identifiers. That means that you cannot put the @param(s) before @switch(es) in the command or @prop(s) before @param(s) in the identifier.

License

This project is made available under the MIT License.