Add doc gen instructions

This commit is contained in:
Rochet2
2014-08-11 11:48:18 +03:00
parent 8ab66a5eab
commit 1c2eceed3c
2 changed files with 16 additions and 1 deletions

View File

@@ -12,7 +12,7 @@ namespace LuaSpell
/**
* Returns 'true' if the &Spell is automatically repeating, false otherwise.
*
* @return boolean isAutoRepeating
* @return bool isAutoRepeating
*/
int IsAutoRepeat(lua_State* L, Spell* spell)
{

15
docs/DOC_GEN.md Normal file
View File

@@ -0,0 +1,15 @@
#Documentation generation
##Setting up
- install [python](https://www.python.org/)(2)
- when installing, tick to install the path variable
- may need restart after for installation to properly take effect
- install a package manager like [pip](https://pip.pypa.io/en/latest/)
- if installed pip and doesnt work, restart or try easy_install command
- install the dependencies with manager
- [Jinja2](https://pypi.python.org/pypi/Jinja2)
- [typedecorator](https://pypi.python.org/pypi/typedecorator)
- [markdown](https://pypi.python.org/pypi/Markdown)
##Generating
- Run in cmd `python -m ElunaDoc` when at `\LuaEngine\docs\`