-
-
Notifications
You must be signed in to change notification settings - Fork 48
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.
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
Add Doc Comments to Allow Docs Generation #13
Labels
Comments
Looks good, I will consider improving the document later. Thanks! |
Documentation is desperately needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
Project could benefit from more thorough documentation. Demo examples are nice, but I think it could be better to show exactly what classes/API functions are available and how they are to be called, what the expected parameters are.
Describe the solution you'd like
Add LDoc or similar doc comments to generate docs.
Describe alternatives you've considered
Other alternative would be LuaDoc. These two are the most popular on LuaRocks.
Additional context
Generated docs would be comparable to Penlight's, T-Engine or similar.
The text was updated successfully, but these errors were encountered: