Skip to content

Files

Latest commit

 

History

History

typedoc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Typedoc

This page explains how to use Typedoc.

Generate site

Run npm run td in to generate the site at typedoc/site/index.html which you can open in your browser.

This also generates a JSON file of the models that are displayed, which you can find in typedoc/models/reflections.json. It was used to review the data that was available to display to implement the searchable-parameters-plugin.

The configuration for Typedoc at typedoc/typedoc.js is set to only display functions exposed by src/linting/eslint/rules/helpers/index.ts.

Publication

The site is published by the Github Action typedoc.yml at https://sonarsource.github.io/SonarJS/typedoc/