fix: regression in toc causing crash

documentationjs · Sep 4, 2017 · 125a577 · 125a577
1 parent 5bdbf1f
commit 125a577
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/__tests__/__snapshots__/test.js.snap b/__tests__/__snapshots__/test.js.snap
@@ -50,6 +50,10 @@ This function is third
 
 This function is first
 
+### first
+
+forgot a memberof here... sure hope that doesn't crash anything!
+
 ## Bravo
 
 Contains a subsection!
@@ -80,6 +84,13 @@ second::bar
 
 -   \`beans\`  
 -   \`rice\`  
+
+## AClass
+
+### second
+
+shares a name with a top level item referenced in the TOC... sure hope
+that doesn't crash anything!
 "
 `;
 

diff --git a/__tests__/fixture/sections.input.js b/__tests__/fixture/sections.input.js
@@ -3,6 +3,21 @@
  */
 function first() {}
 
+/** */
+class AClass {
+  /**
+   * forgot a memberof here... sure hope that doesn't crash anything!
+   * @method first
+   */
+  first(x, y) {}
+
+  /**
+   * shares a name with a top level item referenced in the TOC... sure hope
+   * that doesn't crash anything!
+   */
+  second() {}
+}
+
 /**
  * This class has some members
  */

diff --git a/src/sort.js b/src/sort.js
@@ -64,9 +64,10 @@ module.exports = function sortDocs(comments: Array<Comment>, options: Object) {
   options.toc.forEach(walk.bind(null, []));
   var unfixed = [];
   comments.forEach(function(comment) {
-    const commentPath = paths[comment.name];
-    if (commentPath) {
+    let commentPath;
+    if (!comment.memberof && (commentPath = paths[comment.name])) {
       comment.path = commentPath;
+      delete paths[comment.name];
     }
 
     // If comment is of kind 'note', this means that we must be _re_ sorting