Skip to content

Commit f60074b

Browse files
authored
Merge pull request #6 from mkslanc/new-types
Change generator to work with new JSDoc-based Type System
2 parents d6b7178 + 8b105b5 commit f60074b

13 files changed

+158
-3195
lines changed

AceGitLinkPlugin.js

-263
This file was deleted.

BorrowsTagPlugin.js

-46
This file was deleted.

README.md

+1-30
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,6 @@
11
# Ace documentation generator
22

3-
requires node >= 8
4-
5-
```bash
6-
node generateAnnotations.js AceDirName/ace/src
7-
```
8-
9-
Creates `classes.json` file in directory `generated`.
10-
There will be warnings in `generated\annotations.log` for duplicated classes\methods implementations from different files.
11-
12-
Apply `classes.json` file to declaration with command
13-
14-
```bash
15-
node generateNewDts.js ace.d.ts
16-
```
17-
18-
There will be some information in `generated\declarations.log` that you could use for improving declaration file. (Missing events, methods, constructors)
19-
20-
The final step will generate output documentation with TypeDoc.
21-
You will need to change `generator-options.json` with your settings.
3+
requires node >= 16
224

235
Important! Set `ACE_VERSION` variable which is used with `gitLink` parameter to constuct Ace release link - for example: `https://github.com/ajaxorg/ace/tree/v1.4.2/`
246

@@ -28,14 +10,3 @@ node generateDoc.js doc
2810
```
2911

3012
First parameter - output directory for documentation
31-
32-
Also log file will be created in `generated` dir with name `documentation.log`
33-
34-
35-
36-
```bash
37-
export ACE_VERSION="v$(node -p 'require("ace/package.json").version')"
38-
node generateAnnotations.js ace/src
39-
node generateNewDts.js ace.d.ts
40-
node generateDoc.js doc
41-
```

0 commit comments

Comments
 (0)