Enum comments

This commit is contained in:
Nathan Kunicki 2018-06-20 15:05:12 +01:00
parent a2e254fa18
commit 808e5d431f
2 changed files with 18 additions and 1 deletions

View File

@ -18,17 +18,34 @@ export enum Devices {
BOOST_TILT = 40 BOOST_TILT = 40
} }
/**
* Enum for colors.
* @readonly
* @enum {number}
*/
export enum Colors { export enum Colors {
/** @member {number} NONE */
NONE = 0, NONE = 0,
/** @member {number} PINK */
PINK = 1, PINK = 1,
/** @member {number} PURPLE */
PURPLE = 2, PURPLE = 2,
/** @member {number} BLUE */
BLUE = 3, BLUE = 3,
/** @member {number} LIGHT_BLUE */
LIGHT_BLUE = 4, LIGHT_BLUE = 4,
/** @member {number} CYAN */
CYAN = 5, CYAN = 5,
/** @member {number} GREEN */
GREEN = 6, GREEN = 6,
/** @member {number} YELLOW */
YELLOW = 7, YELLOW = 7,
/** @member {number} ORANGE */
ORANGE = 8, ORANGE = 8,
/** @member {number} RED */
RED = 9, RED = 9,
/** @member {number} WHITE */
WHITE = 10 WHITE = 10
} }

View File

@ -6,7 +6,7 @@
"types": "dist/lpf2.d.ts", "types": "dist/lpf2.d.ts",
"scripts": { "scripts": {
"build": "tslint -c tslint.json \"*.ts\" && tsc", "build": "tslint -c tslint.json \"*.ts\" && tsc",
"docs": "jsdoc2md dist/lpf2.js dist/boosthub.js dist/wedo2hub.js dist/hub.js > README.md" "docs": "jsdoc2md dist/lpf2.js dist/boosthub.js dist/wedo2hub.js dist/hub.js dist/consts.js > README.md"
}, },
"author": "Nathan Kunicki <me@nathankunicki.com>", "author": "Nathan Kunicki <me@nathankunicki.com>",
"license": "MIT", "license": "MIT",