From 1c2eceed3cf0ec6ba1d1b25bd2cc222794cddb48 Mon Sep 17 00:00:00 2001 From: Rochet2 Date: Mon, 11 Aug 2014 11:48:18 +0300 Subject: [PATCH] Add doc gen instructions --- SpellMethods.h | 2 +- docs/DOC_GEN.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docs/DOC_GEN.md diff --git a/SpellMethods.h b/SpellMethods.h index 690ecf8..caceee8 100644 --- a/SpellMethods.h +++ b/SpellMethods.h @@ -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) { diff --git a/docs/DOC_GEN.md b/docs/DOC_GEN.md new file mode 100644 index 0000000..e84c8a3 --- /dev/null +++ b/docs/DOC_GEN.md @@ -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\`