As a user of Anarchy Engine,
it is currently very difficult to find all of the existing functionality with the Lua API. It would be good to create either JavaDoc comments or LDoc comments around the existing Lua API.
so that developers will be able to see what properties, events, and functions are available to them
Ideally this documentation could be exposed in the editor. This concept could be extended to automatically showing documentation on user-created scripts.
Acceptance Criteria:
- Documentation comments are added to the Lua APIs
- Documentation is either generated in the editor or as a markdown file on GitHub
As a user of Anarchy Engine,
it is currently very difficult to find all of the existing functionality with the Lua API. It would be good to create either JavaDoc comments or LDoc comments around the existing Lua API.
so that developers will be able to see what properties, events, and functions are available to them
Ideally this documentation could be exposed in the editor. This concept could be extended to automatically showing documentation on user-created scripts.
Acceptance Criteria: