Updated the documentation

cedx · Jun 11, 2019 · beaef5f · beaef5f
1 parent 201a311
commit beaef5f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/doc/usage.md b/doc/usage.md
@@ -7,7 +7,10 @@ source: lib/enum.js
 Just use the `Enum.create()` method with an object literal containing scalar values (i.e. only booleans, numbers and strings):
 
 ```js
-/** Specifies the days of the week. */
+/**
+ * Specifies the days of the week.
+ * @enum {number}
+ */
 const DayOfWeek = Enum.create({
   sunday: 0,
   monday: 1,

diff --git a/example/index.html b/example/index.html
@@ -10,7 +10,10 @@
     <p>Open the console provided by the development tools of your browser...</p>
 
     <script>
-      /** Specifies the days of the week. */
+      /**
+       * Specifies the days of the week.
+       * @enum {number}
+       */
       const DayOfWeek = Enum.create({
         sunday: 0,
         monday: 1,

diff --git a/example/main.js b/example/main.js
@@ -1,7 +1,10 @@
 /* eslint-disable capitalized-comments, line-comment-position, no-unused-vars */
 import {Enum} from '@cedx/enum';
 
-/** Specifies the days of the week. */
+/**
+ * Specifies the days of the week.
+ * @enum {number}
+ */
 const DayOfWeek = Enum.create({
   sunday: 0,
   monday: 1,