Skip to content

Plugin For JSDoc that converts Brightscript files into comments compatible with JSDoc

Notifications You must be signed in to change notification settings

triwav/roku-jsdocs-plugin

Repository files navigation

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.

About

Plugin For JSDoc that converts Brightscript files into comments compatible with JSDoc

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published