Infer getters as properties, not functions

Author: tmcw

lib/infer/kind.js

@@ -34,7 +34,9 @@ module.exports = function () {
       } else if (t.isClassDeclaration(path)) {
         comment.kind = 'class';
       } else if (t.isFunction(path)) {
-        if (path.node && path.node.id && path.node.id.name && !!/^[A-Z]/.exec(path.node.id.name)) {
+        if (path.node && path.node.kind === 'get') {
+          comment.kind = 'member';
+        } else if (path.node && path.node.id && path.node.id.name && !!/^[A-Z]/.exec(path.node.id.name)) {
           comment.kind = 'class';
         } else {
           comment.kind = 'function';

test/fixture/es6-import.output.json

@@ -2,6 +2,11 @@
 
 This is a sink
 
+## aGetter
+
+This is a getter method: it should be documented
+as a property.
+
 ## constructor
 
 **Parameters**

test/fixture/es6-import.output.md

@@ -42,6 +42,51 @@
         "indent": []
       }
     },
+    {
+      "depth": 2,
+      "type": "heading",
+      "children": [
+        {
+          "type": "text",
+          "value": "aGetter"
+        }
+      ]
+    },
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "text",
+          "value": "This is a getter method: it should be documented\nas a property.",
+          "position": {
+            "start": {
+              "line": 1,
+              "column": 1
+            },
+            "end": {
+              "line": 2,
+              "column": 15
+            },
+            "indent": [
+              1
+            ]
+          }
+        }
+      ],
+      "position": {
+        "start": {
+          "line": 1,
+          "column": 1
+        },
+        "end": {
+          "line": 2,
+          "column": 15
+        },
+        "indent": [
+          1
+        ]
+      }
+    },
     {
       "depth": 2,
       "type": "heading",

test/fixture/es6-import.output.md.json

@@ -40,6 +40,14 @@ class Sink {
     return 'hello';
   }
 
+  /**
+   * This is a getter method: it should be documented
+   * as a property.
+   */
+  get aGetter() {
+    return 42;
+  }
+
   /**
    * @param {number} height the height of the thing
    * @param {number} width the width of the thing

test/fixture/es6.input.js

@@ -2,6 +2,11 @@
 
 This is a sink
 
+## aGetter
+
+This is a getter method: it should be documented
+as a property.
+
 ## constructor
 
 **Parameters**

test/fixture/es6.output.json

@@ -42,6 +42,51 @@
         "indent": []
       }
     },
+    {
+      "depth": 2,
+      "type": "heading",
+      "children": [
+        {
+          "type": "text",
+          "value": "aGetter"
+        }
+      ]
+    },
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "text",
+          "value": "This is a getter method: it should be documented\nas a property.",
+          "position": {
+            "start": {
+              "line": 1,
+              "column": 1
+            },
+            "end": {
+              "line": 2,
+              "column": 15
+            },
+            "indent": [
+              1
+            ]
+          }
+        }
+      ],
+      "position": {
+        "start": {
+          "line": 1,
+          "column": 1
+        },
+        "end": {
+          "line": 2,
+          "column": 15
+        },
+        "indent": [
+          1
+        ]
+      }
+    },
     {
       "depth": 2,
       "type": "heading",

test/fixture/es6.output.md

@@ -118,3 +118,13 @@ function bar() {
  */
 
 bar();
+
+/**
+ * This is Foo
+ */
+class Foo {
+  /**
+   * This is bar
+   */
+  get bar() { }
+}

test/fixture/es6.output.md.json

@@ -1620,6 +1620,16 @@ h4:hover .anchorjs-link {
             class='col12 block field'
             type='text' />
           <div id='toc'>
+              <a
+                href='#Foo'
+                class='block bold'>
+                Foo
+              </a>
+                <a
+                  href='#Foo.bar'
+                  class='regular block'>
+                  #bar
+                </a>
               <a
                 href='#bar'
                 class='block bold'>
@@ -1686,6 +1696,44 @@ h4:hover .anchorjs-link {
       <div class='fix-margin-3'>
         <div class='px2'>
 <div class='py1'><section class='py2 clearfix'>
+  <h2 id='Foo' class='mt0'>
+    Foo<span class='gray'></span>
+  </h2>
+  
+  
+  
+  
+  
+  <p>This is Foo</p>
+
+      <h4>Instance members</h4>
+        <div class='collapsible' id='Foo.bar'>
+          <a href='#Foo.bar'>
+            <code>
+              #bar<span class='gray'></span>
+            </code>
+            <div class='force-inline'>
+              <p>This is bar</p>
+
+            </div>
+          </a>
+          <div class='collapser border px2'>
+<section class='py2 clearfix'>
+  <h2 id='Foo.bar' class='mt0'>
+    bar<span class='gray'></span>
+  </h2>
+  
+  
+  
+  
+  
+  <p>This is bar</p>
+
+</section>
+          </div>
+        </div>
+</section>
+</div><div class='py1'><section class='py2 clearfix'>
   <h2 id='bar' class='mt0'>
     bar<span class='gray'></span>
   </h2>