docs: generate docs

Author: brettz9

README.md

@@ -1289,6 +1289,13 @@ function quux (foo) {
  * @version
  */
 function quux (foo) {}
+
+/**
+ *
+ */
+function quux (foo) {
+
+}
 ````
 
 
@@ -2083,6 +2090,13 @@ function quux (foo) {
 
 }
 // Settings: {"jsdoc":{"preferredTypes":{"object<>":"GenericObject"}}}
+
+/**
+ * @param {Number<} Ignore the error as not a validating rule
+ */
+function quux (foo) {
+
+}
 ````
 
 
@@ -2142,6 +2156,18 @@ class quux {
   }
 }
 
+/**
+ *
+ */
+const quux = class {
+  /**
+   * @implements {SomeClass}
+   */
+  constructor () {
+
+  }
+}
+
 /**
  *
  */
@@ -2511,6 +2537,17 @@ function quux () {
 // Options: ["always"]
 // Message: There must be a newline after the description of the JSDoc block.
 
+/**
+ * Foo.
+ *
+ * Foo.
+ * @foo
+ */
+function quux () {
+
+}
+// Message: There must be a newline after the description of the JSDoc block.
+
 /**
  * Bar.
  *
@@ -3345,6 +3382,16 @@ function quux () {
 }
 // Settings: {"jsdoc":{"avoidExampleOnConstructors":true}}
 
+class Foo {
+  /**
+   *
+   */
+  constructor () {
+
+  }
+}
+// Settings: {"jsdoc":{"avoidExampleOnConstructors":true}}
+
 /**
  * @inheritdoc
  */
@@ -3387,6 +3434,14 @@ function quux () {
 // Options: ["always"]
 // Message: There must be a hyphen before @param description.
 
+/**
+ * @param foo Foo.
+ */
+function quux () {
+
+}
+// Message: There must be a hyphen before @param description.
+
 /**
  * @param foo - Foo.
  */
@@ -3436,6 +3491,13 @@ function quux () {
 
 }
 // Options: ["never"]
+
+/**
+ * @param foo
+ */
+function quux () {
+
+}
 ````
 
 
@@ -3491,6 +3553,12 @@ function quux (foo) {
 }
 // Message: Missing JSDoc comment.
 
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"exemptEmptyFunctions":true}}
+// Message: Missing JSDoc comment.
+
 function myFunction() {}
 // Message: Missing JSDoc comment.
 
@@ -3923,11 +3991,23 @@ class A {
 // Options: [{"require":{"ClassDeclaration":false,"MethodDefinition":false}}]
 
 /**
- Function doing something
+* Function doing something
 */
 var myFunction = () => {}
 // Options: [{"require":{"ArrowFunctionExpression":true}}]
 
+/**
+* Function doing something
+*/
+var myFunction = function () {}
+// Options: [{"require":{"ArrowFunctionExpression":true}}]
+
+/**
+* Function doing something
+*/
+var myFunction = () => {}
+// Options: [{"require":{"ArrowFunctionExpression":false}}]
+
 /**
  Function doing something
 */
@@ -5177,6 +5257,16 @@ async function quux () {
 }
 // Options: [{"forceReturnsWithAsync":true}]
 // Message: Missing JSDoc @returns declaration.
+
+/**
+ * @returns {undefined}
+ * @returns {void}
+ */
+function quux (foo) {
+
+  return foo;
+}
+// Message: Found more than one @returns declaration.
 ````
 
 The following patterns are not considered problems:
@@ -5501,6 +5591,22 @@ function quux() {
 }
 // Message: Syntax error in type: Array<string
 
+/**
+ * @memberof module:namespace.SomeClass<~
+ */
+function quux() {
+
+}
+// Message: Syntax error in type: module:namespace.SomeClass<~
+
+/**
+ * @memberof module:namespace.SomeClass~<
+ */
+function quux() {
+
+}
+// Message: Syntax error in type: module:namespace.SomeClass~<
+
 /**
  * @borrows foo% as bar
  */
@@ -5646,6 +5752,13 @@ function quux() {
  */
 function quux() {
 
+}
+
+/**
+ *
+ */
+function quux() {
+
 }
 ````