https://github.com/mkslanc/ace-docs
Ace documentation generator
https://github.com/mkslanc/ace-docs
Last synced: 29 days ago
JSON representation
Ace documentation generator
- Host: GitHub
- URL: https://github.com/mkslanc/ace-docs
- Owner: mkslanc
- Created: 2022-08-05T10:23:40.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-01T12:40:05.000Z (about 3 years ago)
- Last Synced: 2025-01-25T10:14:19.098Z (9 months ago)
- Language: JavaScript
- Homepage: https://mkslanc.github.io/ace-docs/index.html
- Size: 1.62 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ace documentation generator
requires node >= 8
```
node generateAnnotations.js AceDirName/ace/src
```
Creates `classes.json` file in directory `generated`.
There will be warnings in `generated\annotations.log` for duplicated classes\methods implementations from different files.
Apply `classes.json` file to declaration with command
```
node generateNewDts.js ace.d.ts
```
There will be some information in `generated\declarations.log` that you could use for improving declaration file. (Missing events, methods, constructors)
The final step will generate output documentation with TypeDoc.
You will need to change `generator-options.json` with your settings.
Important! Change `gitLink` parameter with used Ace release link - for example: `https://github.com/ajaxorg/ace/tree/v1.4.2/`
```
node generateDoc.js doc
```
First parameter - output directory for documentation
Also log file will be created in `generated` dir with name `documentation.log`
```
node generateAnnotations.js ace/lib/ace
node generateNewDts.js ace.d.ts
node generateDoc.js doc
```