https://github.com/leafo/moondoc
MoonScript library documentation generator
https://github.com/leafo/moondoc
Last synced: about 1 month ago
JSON representation
MoonScript library documentation generator
- Host: GitHub
- URL: https://github.com/leafo/moondoc
- Owner: leafo
- Created: 2017-06-03T01:15:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-20T05:08:21.000Z (almost 8 years ago)
- Last Synced: 2025-04-20T17:39:52.821Z (about 2 months ago)
- Language: Lua
- Size: 19.5 KB
- Stars: 13
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# moondoc
`moondoc` is a command line tool that parses a MoonScript file and returns a
Lua file with metadata about the classes, functions, and constants exported.
It's designed to be part of a pipeline to generate documentation for MoonScript
projects.
It works by usingthe MoonScript parser to extract the AST, then it searches for
for near by comments to add additional metadata. Information is extracted
statically, without running the code, so dynamically generated parts might need
additional annotation.