Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@ coverage
# Oldies
*xxx*

# ignore
doc

/*.log
3 changes: 2 additions & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}))
Expand Down
9 changes: 9 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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');

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
34 changes: 34 additions & 0 deletions testjs/SideNav.js
Original file line number Diff line number Diff line change
@@ -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;
}));