Skip to content

Commit 8aa6527

Browse files
author
AndreyGeonya
committed
gulp jsdoc command fixed, now @param and @return works
1 parent 5dda0d1 commit 8aa6527

File tree

3 files changed

+42
-7
lines changed

3 files changed

+42
-7
lines changed

doc-config.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"tags": {
3+
"allowUnknownTags": true
4+
},
5+
"source": {
6+
"include": [
7+
"./src/graphs/searching/",
8+
"./src/graphs/others/",
9+
"./src/graphs/shortest-path/"
10+
],
11+
"includePattern": ".+\\.js(doc)?$",
12+
"excludePattern": "docs"
13+
},
14+
"plugins": [],
15+
"templates": {
16+
"cleverLinks": false,
17+
"monospaceLinks": true,
18+
"systemName": "remoteFileExplorer",
19+
"footer": "Created by Simon Speich",
20+
"copyright": "2013",
21+
"navType": "vertical",
22+
"theme": "spacelab",
23+
"linenums": true,
24+
"collapseSymbols": true,
25+
"inverseNav": false
26+
},
27+
"opts": {
28+
"template": "templates/default",
29+
"encoding": "utf8",
30+
"destination": "../javascript-algorithms-docs",
31+
"recurse": true,
32+
"private": true,
33+
"readme": "./readme.md"
34+
}
35+
}

gulpfile.js

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
'use strict';
2-
var jsdoc = require('gulp-jsdoc'),
3-
gulp = require('gulp');
2+
var gulp = require('gulp'),
3+
shell = require('gulp-shell');
44

5-
gulp.task('jsdoc', function () {
6-
gulp.src(['./src/**/*.js', "readme.md"])
7-
.pipe(jsdoc('../javascript-algorithms-docs'));
8-
});
5+
gulp.task('jsdoc', shell.task([
6+
'./node_modules/.bin/jsdoc -c ./doc-config.json',
7+
]));

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
},
1212
"devDependencies": {
1313
"gulp": "^3.8.10",
14-
"gulp-jsdoc": "^0.1.4"
14+
"jsdoc": "^3.3.0",
15+
"gulp-shell": "^0.2.11"
1516
},
1617
"scripts": {
1718
"test": "echo \"Error: no test specified\" && exit 1"

0 commit comments

Comments
 (0)