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

LDoc Documentation Generation for Lua Scripts #13

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

LDoc Documentation Generation for Lua Scripts #13

CompilerErrorRBX opened this issue Oct 4, 2019 · 2 comments
Assignees
@orange451
Labels
enhancement New feature or request nice to have A feature or improvement that would be nice to have but isn't necessary in any way.

Comments

@CompilerErrorRBX
Copy link
Collaborator

As a developer in Anarchy Engine
It would be really nice to have LDoc documentation generation supported by the engine
So that when I collaborate with others on a project, they can see the documentation for any code I've written

Acceptance Criteria:

  • LDoc documentation comments are parsed from scripts and displayed to the user
@CompilerErrorRBX CompilerErrorRBX added the enhancement New feature or request label Oct 4, 2019
@CompilerErrorRBX CompilerErrorRBX changed the title LDoc Support in Lua Scripts LDoc Documentation Generation for Lua Scripts Oct 4, 2019
@CompilerErrorRBX CompilerErrorRBX added the nice to have A feature or improvement that would be nice to have but isn't necessary in any way. label Oct 4, 2019
@orange451
Copy link
Owner

Is there a specific format you would like?

@orange451 orange451 self-assigned this Oct 24, 2019
@CompilerErrorRBX
Copy link
Collaborator Author

I want all of this. https://stevedonovan.github.io/ldoc/manual/doc.md.html

JK, will settle for just the LuaDoc styling, anything else is bonus :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orange451 orange451

Labels
enhancement New feature or request nice to have A feature or improvement that would be nice to have but isn't necessary in any way.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@orange451 @CompilerErrorRBX