fixes README example #5

Author: 75lb

README.md

@@ -8,43 +8,45 @@
 
 ***[Try the jsdoc2md v2 pre-release](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)***
 
-<a name="module_jsdoc-api"></a>
+# jsdoc-api
 
-## jsdoc-api
 A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a few features:
 
 - Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
 - Input (source code) can supplied as a string or set of file names/globs.
 - Optional caching, dramatically speeding up future invocations with the same input.
 - Supports html input
 
-**Example**  
+## Synopsis
+
 ```js
 > const jsdoc = require('jsdoc-api')
 
-> jsdoc.explainSync({ source: '/** example doclet *∕ \n var example = true' })
-
+> jsdoc.explainSync({ source: '/** example doclet */ \n var example = true' })
 [ { comment: '/** example doclet *∕',
-    meta:
-     { range: [ 28, 42 ],
-       filename: 'nkrf18zlymohia4i29a0zkyt84obt9.js',
-       lineno: 2,
-       path: '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T',
-       code:
-        { id: 'astnode100000002',
-          name: 'example',
-          type: 'Literal',
-          value: true } },
-    description: 'example doclet',
-    name: 'example',
-    longname: 'example',
-    kind: 'member',
-    scope: 'global' },
-  { kind: 'package',
-    longname: 'package:undefined',
-    files: [ '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T/nkrf18zlymohia4i29a0zkyt84obt9.js' ] } ]
+   meta:
+    { range: [ 28, 42 ],
+      filename: 'nkrf18zlymohia4i29a0zkyt84obt9.js',
+      lineno: 2,
+      path: '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T',
+      code:
+       { id: 'astnode100000002',
+         name: 'example',
+         type: 'Literal',
+         value: true } },
+   description: 'example doclet',
+   name: 'example',
+   longname: 'example',
+   kind: 'member',
+   scope: 'global' },
+ { kind: 'package',
+   longname: 'package:undefined',
+   files: [ '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T/nkrf18zlymohia4i29a0zkyt84obt9.js' ] } ]
 ```
 
+# API Reference
+
+
 * [jsdoc-api](#module_jsdoc-api)
     * _static_
         * [.cache](#module_jsdoc-api.cache) : <code>[cache-point](https://github.com/75lb/cache-point)</code>
@@ -73,7 +75,7 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
 <a name="module_jsdoc-api.cache"></a>
 
 ### jsdoc.cache : <code>[cache-point](https://github.com/75lb/cache-point)</code>
-The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()`, `.explainSync()` or `.createExplainStream()`.
+The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()` or `.explainSync()`.
 
 **Kind**: static property of <code>[jsdoc-api](#module_jsdoc-api)</code>  
 <a name="module_jsdoc-api.explainSync"></a>
@@ -238,7 +240,6 @@ Enable experimental parsing of `.html` files.
 
 **Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>  
 
-
 * * *
 
 &copy; 2015-16 Lloyd Brookes \<[email protected]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

jsdoc2md/README.hbs

@@ -8,7 +8,49 @@
 
 ***[Try the jsdoc2md v2 pre-release](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)***
 
-{{#module name="jsdoc-api"}}{{>docs}}{{/module}}
+# jsdoc-api
+
+A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a few features:
+
+- Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
+- Input (source code) can supplied as a string or set of file names/globs.
+- Optional caching, dramatically speeding up future invocations with the same input.
+- Supports html input
+
+## Synopsis
+
+```js
+> const jsdoc = require('jsdoc-api')
+
+> jsdoc.explainSync({ source: '/** example doclet */ \n var example = true' })
+[ { comment: '/** example doclet *∕',
+   meta:
+    { range: [ 28, 42 ],
+      filename: 'nkrf18zlymohia4i29a0zkyt84obt9.js',
+      lineno: 2,
+      path: '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T',
+      code:
+       { id: 'astnode100000002',
+         name: 'example',
+         type: 'Literal',
+         value: true } },
+   description: 'example doclet',
+   name: 'example',
+   longname: 'example',
+   kind: 'member',
+   scope: 'global' },
+ { kind: 'package',
+   longname: 'package:undefined',
+   files: [ '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T/nkrf18zlymohia4i29a0zkyt84obt9.js' ] } ]
+```
+
+# API Reference
+
+{{#module name="jsdoc-api"}}
+{{>body~}}
+{{>member-index~}}
+{{>members~}}
+{{/module}}
 
 * * *
 

lib/jsdoc-api.js

@@ -1,39 +1,8 @@
 'use strict'
 
 /**
- * A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a few features:
- *
- * - Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
- * - Input (source code) can supplied as a string or set of file names/globs.
- * - Optional caching, dramatically speeding up future invocations with the same input.
- * - Supports html input
- *
  * @module jsdoc-api
  * @typicalname jsdoc
- * @example
- * > const jsdoc = require('jsdoc-api')
- *
- * > jsdoc.explainSync({ source: '/** example doclet *∕ \n var example = true' })
- *
- * [ { comment: '/** example doclet *∕',
- *     meta:
- *      { range: [ 28, 42 ],
- *        filename: 'nkrf18zlymohia4i29a0zkyt84obt9.js',
- *        lineno: 2,
- *        path: '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T',
- *        code:
- *         { id: 'astnode100000002',
- *           name: 'example',
- *           type: 'Literal',
- *           value: true } },
- *     description: 'example doclet',
- *     name: 'example',
- *     longname: 'example',
- *     kind: 'member',
- *     scope: 'global' },
- *   { kind: 'package',
- *     longname: 'package:undefined',
- *     files: [ '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T/nkrf18zlymohia4i29a0zkyt84obt9.js' ] } ]
  */
 exports.explainSync = explainSync
 exports.explain = explain
@@ -42,7 +11,7 @@ exports.renderSync = renderSync
 const path = require('path')
 const Cache = require('cache-point')
 /**
- * The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()`, `.explainSync()` or `.createExplainStream()`.
+ * The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()` or `.explainSync()`.
  * @type {external:cache-point}
  */
 exports.cache = new Cache({ dir: path.join(require('os').tmpdir(), 'jsdoc-api') })

package.json

@@ -30,7 +30,7 @@
     "coveralls": "^2.11.14",
     "jsdoc-to-markdown": "^2.0.0-alpha.8",
     "rimraf": "^2.5.4",
-    "test-runner": "~0.2.3"
+    "test-runner": "~0.2.4"
   },
   "dependencies": {
     "array-back": "^1.0.3",
@@ -41,7 +41,7 @@
     "file-set": "^1.0.2",
     "jsdoc-75lb": "^3.5.6",
     "object-to-spawn-args": "^1.1.0",
-    "promise.prototype.finally": "^2.0.0",
+    "promise.prototype.finally": "^2.0.1",
     "temp-path": "^1.0.0",
     "then-fs": "^2.0.0",
     "walk-back": "^2.0.1"

test/explain-sync.js

@@ -27,6 +27,11 @@ if (require('child_process').spawnSync) {
     a.deepEqual(output, expectedOutput)
   })
 
+  runner.test('.explainSync({ source }), defaults', function () {
+    var output = jsdoc.explainSync({ source: '/** example doclet */ \n var example = true' })
+    a.strictEqual(output[0].description, 'example doclet')
+  })
+
   runner.test('.explainSync: no valid files', function () {
     a.throws(
       function () {