Git Product home page Git Product logo

ace-api-docs's Introduction

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

export ACE_VERSION="v$(node -p 'require("../package.json").version')"
node generateDoc.js doc

First parameter - output directory for documentation

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

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

ace-api-docs's People

Contributors

mkslanc avatar nightwing avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.