Improve comment typedef while we're at it

documentationjs · Jan 29, 2017 · 121803b · 121803b
1 parent c99bbe2
commit 121803b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/declarations/comment.js b/declarations/comment.js
@@ -86,7 +86,19 @@ declare type Remark = {
   children: Array<Object>
 };
 
+declare type Access = 'private' | 'public' | 'protected';
 declare type Scope = 'instance' | 'static' | 'inner' | 'global';
+declare type Kind = 'class' |
+  'constant' |
+  'event' |
+  'external' |
+  'file' |
+  'function' |
+  'member' |
+  'mixin' |
+  'module' |
+  'namespace' |
+  'typedef';
 
 declare type Comment = {
   errors: Array<CommentError>,
@@ -110,10 +122,11 @@ declare type Comment = {
   members: CommentMembers,
 
   name?: string,
-  kind?: string,
+  kind?: Kind,
+
   memberof?: string,
   scope?: Scope,
-  access?: string,
+  access?: Access,
   alias?: string,
 
   copyright?: string,
@@ -136,6 +149,6 @@ declare type Comment = {
 
 declare type ReducedComment = {
   name: string,
-  kind: ?string,
+  kind: ?Kind,
   scope?: ?Scope
 }
diff --git a/lib/parse.js b/lib/parse.js
@@ -21,6 +21,7 @@ var flatteners = {
    * @returns {undefined} has side-effects
    */
   'access': function (result, tag) {
+    // doctrine ensures that tag.access is valid
     result.access = tag.access;
   },
   'alias': flattenName,
@@ -208,6 +209,7 @@ var flatteners = {
    * @returns {undefined} has side-effects
    */
   'kind': function (result, tag) {
+    // doctrine ensures that tag.kind is valid
     result.kind = tag.kind;
   },
   'lends': flattenDescription,