diff --git a/.gitignore b/.gitignore index 52e8107..4b9c009 100644 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,7 @@ coverage # Oldies *xxx* +# ignore +doc + /*.log diff --git a/gulpfile.js b/gulpfile.js index 6cac334..57da63c 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -73,7 +73,8 @@ gulp.task('doc-simple', function() { gulp.src([ 'index.js', - 'lib/**/*.js' + 'lib/**/*.js', + 'testjs/**/*.js' ]) // Process source files first .pipe(template({pkg: pkg})) diff --git a/index.js b/index.js index 1c0d096..aed3060 100644 --- a/index.js +++ b/index.js @@ -10,6 +10,15 @@ var marked = require('marked'); + /** + * Add jsdoc to node_module path to make new version(3.3.0-alpha9) run + */ + var path = require('path'); + require = require('requizzle')({ + requirePaths: [path.join(__dirname, 'node_modules/jsdoc/lib')], + infect: true + }) + var Parser = require('./lib/parser.js'); var Generator = require('./lib/generator.js'); diff --git a/package.json b/package.json index 01ed9ba..795593e 100644 --- a/package.json +++ b/package.json @@ -36,10 +36,11 @@ "chalk": "~0.4.0", "text-table": "~0.2.0", "vinyl-fs": "~0.3.0", - "jsdoc": "3.3.0-alpha5", + "jsdoc": "3.3.0-alpha9", "taffydb": "~2.7.2", "ink-docstrap": "~0.4.5", "wrench": "~1.5.6", + "requizzle": "^0.2.0", "marked": "~0.3.1" }, "devDependencies": { diff --git a/testjs/SideNav.js b/testjs/SideNav.js new file mode 100644 index 0000000..152cb68 --- /dev/null +++ b/testjs/SideNav.js @@ -0,0 +1,34 @@ +/** + * SideNav + * nav item must be a and attribute of href must be #xxx , #xxx nav will trigger scroll by explorer + * @module SideNav + * @requires module:jquery + */ +(function (root, facotry) { + + if (typeof define === 'function' && define.amd) { + define(['jquery'], facotry); + }else { + root['SideNav'] = facotry($); + } + +}(this, function ($) { + + /** + * + * @constructor + * @alias module:SideNav + * @param {Object} [setting] setting object + * @param {String} setting.el jquery selector . + * @param {String} setting.nav navigation button. + * @param {String} setting.target target area + * @param {String} [setting.container] nav container + * @param {String} [setting.autoNav] whether listen to the change of area , default is true + * @param {String} [setting.fixTop] fixtop + * + */ + var SideNav = function (setting) { + } + + return SideNav; +}));