docs

Author: 75lb

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Lloyd Brookes <75pound@gmail.com>
+Copyright (c) 2014-16 Lloyd Brookes <75pound@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -18,49 +18,24 @@ jsdoc-parse extends [jsdoc](https://github.com/jsdoc3/jsdoc) with a few features
   * `@chainable`: Set to mark a method as chainable (has a return value of `this`).
 
 ## API Reference
-
-<a name="module_jsdoc-parse"></a>
 
 **Example**
 ```js
 var jsdocParse = require('jsdoc-parse')
 ```
 
-* jsdoc-parse
-    * [~parse(jsdocExplainOutput, [options])](#module_jsdoc-parse..parse)   
-    * [~applyOptions(data, options)](#module_jsdoc-parse..applyOptions) ⇒ `string`  
-    * [~getStats(data)](#module_jsdoc-parse..getStats) ⇒ `object`  
-
 
-<a name="module_jsdoc-parse..parse"></a>
-### jsdoc-parse~parse(jsdocExplainOutput, [options])   
-**Kind**: inner method of module:jsdoc-parse  
-**Params**
+### parse(jsdocData, [options]) ⇒ Array.&lt;object&gt; ⏏
+**Kind**: Exported function  
+__Params__
 
-- jsdocExplainOutput Array.<object> - jsdoc output
+- jsdocData Array.&lt;object&gt; - jsdoc output
 - [options] object
     - [.private] boolean - Include identifier documentation marked as `@private` in the output
-    - [.html] boolean - Enable experimental parsing of .html files.
-    - [.sort-by] Array.<string> <code> = [ 'scope', 'category', 'kind', 'order' ]</code> - Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to remove the default sort order.
-
-<a name="module_jsdoc-parse..applyOptions"></a>
-### jsdoc-parse~applyOptions(data, options) ⇒ `string`  
-**Kind**: inner method of module:jsdoc-parse  
-**Params**
-
-- data string - input json string
-- options object - jsdoc-parse options
-
-<a name="module_jsdoc-parse..getStats"></a>
-### jsdoc-parse~getStats(data) ⇒ `object`  
-return some stats about the parsed data
 
-**Kind**: inner method of module:jsdoc-parse  
-**Params**
 
-- data object - jsdoc-parse data
 
 
 * * *
 
-&copy; 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).
+&copy; 2014-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).

es5/jsdoc-parse.js

@@ -4,9 +4,9 @@ var transform = require('./transform');
 
 exports.parse = parse;
 
-function parse(jsdocExplainOutput, options) {
+function parse(jsdocData, options) {
   options = options || {};
-  var data = transform(jsdocExplainOutput);
+  var data = transform(jsdocData);
 
   data = data.filter(function (doclet) {
     var parent = data.find(function (d) {

jsdoc2md/README.md

@@ -22,4 +22,4 @@ ${docs.renderAll()}
 
 * * *
 
-&copy; 2015 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).
+&copy; 2014-16 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).

lib/jsdoc-parse.js

@@ -14,10 +14,12 @@ exports.parse = parse
  * @param {object[]} - jsdoc output
  * @param [options] {object}
  * @param [options.private] {boolean} - Include identifier documentation marked as `@private` in the output
+ * @returns {object[]}
+ * @alias module:jsdoc-parse
  */
-function parse (jsdocExplainOutput, options) {
+function parse (jsdocData, options) {
   options = options || {}
-  let data = transform(jsdocExplainOutput)
+  let data = transform(jsdocData)
 
   data = data.filter(function (doclet) {
     var parent = data.find(d => d.id === doclet.memberof) || {}

package.json

@@ -23,16 +23,16 @@
   },
   "dependencies": {
     "array-back": "^1.0.2",
-    "core-js": "^2.1.0",
+    "core-js": "^2.1.3",
     "feature-detect-es6": "^1.2.0",
     "filter-where": "^1.0.1",
-    "object-tools": "^2",
+    "object-tools": "^2.0.5",
     "reduce-extract": "^1.0.0",
-    "test-value": "^1.0.1"
+    "test-value": "^1.1.0"
   },
   "devDependencies": {
-    "babel-preset-es2015": "^6.5.0",
-    "tape": "^4.4"
+    "babel-preset-es2015": "^6.6.0",
+    "tape": "^4.5"
   },
   "standard": {
     "ignore": [