Skip to content

Commit 04c63da

Browse files
committed
upgrade deps.. docs
1 parent 117f31a commit 04c63da

File tree

8 files changed

+28
-142
lines changed

8 files changed

+28
-142
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,22 @@
66
[![Join the chat at https://gitter.im/jsdoc2md/jsdoc2md](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jsdoc2md/jsdoc2md?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

88
# jsdoc-parse
9-
Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data, adding a few features:
9+
Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data into something more suitable for use as template input. Also adds a few tags to the default set:
1010

1111
* Support for new tags in the input javascript
1212
* `@category <string>`: Useful for grouping identifiers by category.
1313
* `@done`: Used to mark `@todo` items as complete.
1414
* `@typicalname`: If set on a class, namespace or module, child members will documented using this typical name as the parent name. Real-world typical name examples are `$` (the typical name for `jQuery` instances), `_` (underscore) etc.
1515
* `@chainable`: Set to mark a method as chainable (has a return value of `this`).
1616

17+
## Command-line usage
18+
19+
This module is built into [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown/), you can see the output using this command:
20+
21+
```
22+
$ jsdoc2md --json <files>
23+
```
24+
1725
## API Reference
1826
<a name="module_jsdoc-parse"></a>
1927

es5/cli-options.js

Lines changed: 0 additions & 39 deletions
This file was deleted.

es5/publish.js

Lines changed: 0 additions & 60 deletions
This file was deleted.

example/doc.html

Lines changed: 0 additions & 23 deletions
This file was deleted.

example/function.js

Lines changed: 0 additions & 9 deletions
This file was deleted.

jsdoc2md/README.hbs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,22 @@
66
[![Join the chat at https://gitter.im/jsdoc2md/jsdoc2md](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jsdoc2md/jsdoc2md?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

88
# jsdoc-parse
9-
Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data, adding a few features:
9+
Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data into something more suitable for use as template input. Also adds a few tags to the default set:
1010

1111
* Support for new tags in the input javascript
1212
* `@category <string>`: Useful for grouping identifiers by category.
1313
* `@done`: Used to mark `@todo` items as complete.
1414
* `@typicalname`: If set on a class, namespace or module, child members will documented using this typical name as the parent name. Real-world typical name examples are `$` (the typical name for `jQuery` instances), `_` (underscore) etc.
1515
* `@chainable`: Set to mark a method as chainable (has a return value of `this`).
1616

17+
## Command-line usage
18+
19+
This module is built into [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown/), you can see the output using this command:
20+
21+
```
22+
$ jsdoc2md --json <files>
23+
```
24+
1725
## API Reference
1826
{{>main}}
1927

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "jsdoc-parse",
33
"author": "Lloyd Brookes <[email protected]>",
44
"version": "2.0.5-0",
5-
"description": "Jsdoc-annotated source code in, JSON format documentation out.",
5+
"description": "Transforms jsdoc data into something more suitable for use as template input",
66
"repository": "https://github.com/jsdoc2md/jsdoc-parse.git",
77
"main": "index",
88
"license": "MIT",
@@ -19,21 +19,21 @@
1919
"scripts": {
2020
"test": "test-runner test/*.js",
2121
"docs": "jsdoc2md -t jsdoc2md/README.hbs -p list lib/jsdoc-parse.js > README.md; echo",
22-
"es5": "babel --presets babel-preset-es2015 --no-comments lib --out-dir es5"
22+
"es5": "rm -rf es5 && babel --presets babel-preset-es2015 --no-comments lib --out-dir es5"
2323
},
2424
"dependencies": {
2525
"array-back": "^1.0.3",
2626
"core-js": "^2.4.1",
2727
"feature-detect-es6": "^1.3.1",
28-
"lodash.omit": "^4.4.1",
29-
"lodash.pick": "^4.3.0",
28+
"lodash.omit": "^4.5.0",
29+
"lodash.pick": "^4.4.0",
3030
"reduce-extract": "^1.0.0",
3131
"sort-array": "^1.1.1",
32-
"test-value": "^2.0.0"
32+
"test-value": "^2.1.0"
3333
},
3434
"devDependencies": {
35-
"babel-preset-es2015": "^6.13.2",
36-
"test-runner": "~0.1.10"
35+
"babel-preset-es2015": "^6.16.0",
36+
"test-runner": "~0.2.4"
3737
},
3838
"standard": {
3939
"ignore": [

test/api.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
'use strict'
2-
var test = require('test-runner')
2+
var TestRunner = require('test-runner')
33
var jsdocParse = require('../')
44
var fs = require('fs')
55
var a = require('assert')
6+
var runner = new TestRunner()
67

7-
test('api: valid json out', function (t) {
8+
runner.test('api: valid json out', function () {
89
var jsdocOutput = JSON.parse(fs.readFileSync('./test/fixture/jsdoc-input.json', 'utf8'))
910
var data = jsdocParse(jsdocOutput)
1011
a.strictEqual(data[0].name, 'Chainable')

0 commit comments

Comments
 (0)