diff --git a/gulp/tasks/jsdoc.js b/gulp/tasks/jsdoc.js index 65a0d50..b809f13 100644 --- a/gulp/tasks/jsdoc.js +++ b/gulp/tasks/jsdoc.js @@ -10,29 +10,35 @@ './documentation/**' ]; + var docStrapTemplate = { - path : "ink-docstrap", - // the attribute for the web page - systemName : "The official pixi.js documentaion", + // docstrap is included in gulp-jsdoc, thanks guys + path : "ink-docstrap", + // the <title> of the web page + systemName : "The official pixi.js documentaion", // A left-aligned message on the footer - footer : "Made with ♥ by <a href='http://goodboydigital.com'>Goodboy Digital</a>", + footer : "Made with ♥ by <a href='http://goodboydigital.com'>Goodboy Digital</a>", // The centred copyright message - copyright : "© Goodboy Digital Ltd and all its contributors", - navType : "vertical", - theme : "readable", - linenums : true, - collapseSymbols : false, - inverseNav : false + copyright : "© Goodboy Digital Ltd and all the pixi.js contributors", + navType : "vertical", + theme : "readable", + // TODO add + analytics : {"ua":"UA-XXXXX-XXX", "domain":"XXXX"}, + outputSourceFiles : true, + linenums : true, + collapseSymbols : false, + inverseNav : false } function deleteCallback(error,deletedFiles) { - // When the previous docs are deleted, run gulp-jsdoc // return gulp.src('./src/core/display/*.js') .pipe( jsdoc('./documentation',docStrapTemplate) ) } + + // deletes the docs folder and re-generates the documentation del(folders,deleteCallback); }); \ No newline at end of file diff --git a/gulp/tasks/jsdoc.js b/gulp/tasks/jsdoc.js index 65a0d50..b809f13 100644 --- a/gulp/tasks/jsdoc.js +++ b/gulp/tasks/jsdoc.js @@ -10,29 +10,35 @@ './documentation/**' ]; + var docStrapTemplate = { - path : "ink-docstrap", - // the <title> attribute for the web page - systemName : "The official pixi.js documentaion", + // docstrap is included in gulp-jsdoc, thanks guys + path : "ink-docstrap", + // the <title> of the web page + systemName : "The official pixi.js documentaion", // A left-aligned message on the footer - footer : "Made with ♥ by <a href='http://goodboydigital.com'>Goodboy Digital</a>", + footer : "Made with ♥ by <a href='http://goodboydigital.com'>Goodboy Digital</a>", // The centred copyright message - copyright : "© Goodboy Digital Ltd and all its contributors", - navType : "vertical", - theme : "readable", - linenums : true, - collapseSymbols : false, - inverseNav : false + copyright : "© Goodboy Digital Ltd and all the pixi.js contributors", + navType : "vertical", + theme : "readable", + // TODO add + analytics : {"ua":"UA-XXXXX-XXX", "domain":"XXXX"}, + outputSourceFiles : true, + linenums : true, + collapseSymbols : false, + inverseNav : false } function deleteCallback(error,deletedFiles) { - // When the previous docs are deleted, run gulp-jsdoc // return gulp.src('./src/core/display/*.js') .pipe( jsdoc('./documentation',docStrapTemplate) ) } + + // deletes the docs folder and re-generates the documentation del(folders,deleteCallback); }); \ No newline at end of file diff --git a/gulpfile.js b/gulpfile.js index 9376917..6c73f75 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -31,4 +31,5 @@ // default task gulp.task('default', ['jshint', 'build']); -gulp.task('docs',['jsdocs']); \ No newline at end of file +// you can directly use 'gulp jsdocs' to generate the docs +gulp.task('docs','jsdocs'); \ No newline at end of file