Skip to content

Change generator to work with new JSDoc-based Type System #6

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 10, 2024
Merged

Change generator to work with new JSDoc-based Type System #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
942769d
remove unneccessary modules; update typedoc
mkslanc Nov 17, 2023
8b105b5
change node version requirements
mkslanc Dec 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
263 changes: 0 additions & 263 deletions AceGitLinkPlugin.js
View file
Open in desktop

This file was deleted.

46 changes: 0 additions & 46 deletions BorrowsTagPlugin.js
View file
Open in desktop

This file was deleted.

31 changes: 1 addition & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
# Ace documentation generator

requires node >= 8

```bash
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

```bash
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.
requires node >= 16

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/`

Expand All @@ -28,14 +10,3 @@ node generateDoc.js doc
```

First parameter - output directory for documentation

Also log file will be created in `generated` dir with name `documentation.log`



```bash
export ACE_VERSION="v$(node -p 'require("ace/package.json").version')"
node generateAnnotations.js ace/src
node generateNewDts.js ace.d.ts
node generateDoc.js doc
```
Loading