Skip to content

Latest commit

 

History

History
11 lines (10 loc) · 628 Bytes

README.md

File metadata and controls

11 lines (10 loc) · 628 Bytes

What is this?

Plugin For JSDoc that converts Brightscript files into comments compatible with JSDoc. Automatically pulls in function/sub name and param and return types. Can be overridden with more info as desired (description, param type override or param description). Automatically bases module off of file name but can be changed and used to combine multiple files into one module. Module is automatically applied to each sub/function in that file

How To View Example Docs

git clone https://github.com/triwav/roku-jsdocs-plugin.git
cd roku-jsdocs-plugin
npm install
npm run docs

Docs are output in docs folder.