Skip to content
Snippets Groups Projects
Commit 9c48e5c5 authored by Vytor Calixto's avatar Vytor Calixto :space_invader:
Browse files

Add jsdoc

parent e835b3e3
No related branches found
No related tags found
1 merge request!14Add jsdoc
Pipeline #
......@@ -19,3 +19,4 @@ build/*
.gulp-cache
config.json
docs/
......@@ -10,6 +10,8 @@ const nodemon = require('gulp-nodemon');
const Cache = require('gulp-file-cache');
const jsdoc = require('gulp-jsdoc3');
const cache = new Cache();
/**
......@@ -36,6 +38,12 @@ function compile() {
gulp.task('build', compile);
gulp.task('doc', (cb) => {
let config = require('./jsdoc.json');
gulp.src(['README.md', './src/**/*.js'], {read: false})
.pipe(jsdoc(config, cb));
});
gulp.task('test', () => {
gulp.src('test/test.js', {read: false})
.pipe(mocha())
......@@ -69,4 +77,3 @@ gulp.task('run', () => {
});
gulp.task('default', ['run']);
{
"tags": {
"allowUnknownTags": true
},
"plugins": [
"plugins/markdown"
],
"opts": {
"template": "./node_modules/docdash/",
"encoding": "utf8",
"destination": "docs/",
"recurse": true,
"verbose": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment