Skip to content

Commit 7c6674f

Browse files
committed
Updated README and package.json
1 parent 5033b24 commit 7c6674f

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# What is this?
22

3-
Plugin For [JSDoc](https://jsdoc.app/) that converts Brighterscript 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
3+
Plugin For [JSDoc](https://jsdoc.app/) that converts Roku's BrightScriptDoc comments into comments compatible with JSDoc.
4+
5+
Especially designed to work with both [Brightscript](https://developer.roku.com/docs/references/brightscript/language/brightscript-language-reference.md) and [Brighterscript](https://github.com/rokucommunity/brighterscript).
6+
7+
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.
48

59
# How To View Example Docs
610

package.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "brighterscript-jsdocs-plugin",
33
"version": "0.1.4",
44
"description": "Plugin For JSDoc that converts Brighterscript files into comments compatible with JSDoc",
5+
"author": "Mark Pearce",
56
"scripts": {
67
"docs": "rm -rf docs && ./node_modules/.bin/jsdoc -c jsdoc.json -t node_modules/minami -d docs",
78
"test": "sh ./scripts/test.sh"
@@ -11,6 +12,14 @@
1112
"url": "git+https://github.com/markwpearce/brighterscript-jsdocs-plugin.git"
1213
},
1314
"license": "ISC",
15+
"keywords": [
16+
"brightscript",
17+
"brighterscript",
18+
"roku",
19+
"jsdoc",
20+
"jsdocs",
21+
"brightscriptdoc"
22+
],
1423
"bugs": {
1524
"url": "https://github.com/markwpearce/brighterscript-jsdocs-plugin/issues"
1625
},
@@ -21,4 +30,4 @@
2130
"jsdoc": "^3.6.3",
2231
"minami": "^1.2.3"
2332
}
24-
}
33+
}

0 commit comments

Comments
 (0)