From 808e5d431fc10dff9763ccac79160d13477ea4e5 Mon Sep 17 00:00:00 2001
From: Nathan Kunicki <nathank@mediamolecule.com>
Date: Wed, 20 Jun 2018 15:05:12 +0100
Subject: [PATCH] Enum comments

---
 consts.ts    | 17 +++++++++++++++++
 package.json |  2 +-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/consts.ts b/consts.ts
index a632626..73472c5 100644
--- a/consts.ts
+++ b/consts.ts
@@ -18,17 +18,34 @@ export enum Devices {
     BOOST_TILT = 40
 }
 
+
+/**
+ * Enum for colors.
+ * @readonly
+ * @enum {number}
+ */
 export enum Colors {
+    /** @member {number} NONE */
     NONE = 0,
+    /** @member {number} PINK */
     PINK = 1,
+    /** @member {number} PURPLE */
     PURPLE = 2,
+    /** @member {number} BLUE */
     BLUE = 3,
+    /** @member {number} LIGHT_BLUE */
     LIGHT_BLUE = 4,
+    /** @member {number} CYAN */
     CYAN = 5,
+    /** @member {number} GREEN */
     GREEN = 6,
+    /** @member {number} YELLOW */
     YELLOW = 7,
+    /** @member {number} ORANGE */
     ORANGE = 8,
+    /** @member {number} RED */
     RED = 9,
+    /** @member {number} WHITE */
     WHITE = 10
 }
 
diff --git a/package.json b/package.json
index 719bfd5..55bbba3 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,7 @@
   "types": "dist/lpf2.d.ts",
   "scripts": {
     "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>",
   "license": "MIT",