https://github.com/xtuc/yet-another-documentation-generator
Functions documentation for JavaScript
https://github.com/xtuc/yet-another-documentation-generator
Last synced: 12 months ago
JSON representation
Functions documentation for JavaScript
- Host: GitHub
- URL: https://github.com/xtuc/yet-another-documentation-generator
- Owner: xtuc
- Created: 2016-11-01T12:23:13.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-31T11:58:13.000Z (over 9 years ago)
- Last Synced: 2025-08-18T00:34:10.929Z (12 months ago)
- Language: C++
- Size: 4.88 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Yet Another Documentation generator
Functions documentation for JavaScript
## Motiviations
Good introduction to compiler frontend.
Most JavaScript source code will break the tokenizer.
Backend wasn't my main focus, it only generates markdown using a templating engine.
## Projet goal
Document functions from any language.
It should be clear (without author explainations) what the module does: its impact on arguments, used environnement variables, …
## Requirements
* C++11
* Mustache templating engine: https://github.com/no1msd/mstch
* Flex
* GNU/Bison
## Build from source
```sh
make build
```
## Launch test
Requires NPM and Node.
Install test dependencies (Mocha) :
```sh
npm install
```
Launch :
```sh
npm test
```