Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lua API Documentation #12

Open
CompilerErrorRBX opened this issue Oct 4, 2019 · 0 comments
Open

Lua API Documentation #12

CompilerErrorRBX opened this issue Oct 4, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@CompilerErrorRBX
Copy link
Collaborator

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
@CompilerErrorRBX CompilerErrorRBX added the enhancement New feature or request label Oct 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CompilerErrorRBX