eaw-emmyluadoc

A lua "script" that documents EaW LUA functions in such a way that EmmyLua can pick up the hints.

Installation

This file is designed to work in conjunction with EmmyLua, so to make any use of it, you should install EmmyLua for the IDE of you choice.

EmmyLua is currently available for:

• IntelliJ IDEA via the plugin repository.
• VSCode as an extension via the VSCode Marketplace
• Sublime Text 3 as an LSP plugin.
• EMACS as an LSP client.

For use in your mod you then drop the file eaw-emmyluadoc.lua into the mymod/data/scripts/library directory. EmmyLua should automatically pick it up and apply the hints.

⚠️ NOTE: For VSCode a LUA Language Server supporting EmmyLua annotations has been released. We encourage everyone try this LSP implementation instead of EmmyLua - it provides even more accurate support.

Contributing

To contribute additional documentation, follow the set guidelines:

• eaw-types-emmyluadoc.lua contains the documentation for all types (aka classes) that are exposed to the LUA sandbox by the game's C++ code or are otherwise wrapping types.
• eaw-functions-emmyluadoc.lua contains all functions that are otherwise exposed to the LUA sandbox, but are not a member function of a type.
• eaw-pglib-${LIBRARY_NAME}-emmyluadoc.lua contain documentation for all library files.