README.md

swint-yuidoc

YUIDoc document generator for Swint batch task manager(swint-task)

Warning: This is not the final draft yet, so do not use this until its official version is launched

Installation

$ npm install --save swint-yuidoc

Options

• name : String, default: 'Project'
• inDir : String, default: path.dirname(require.main.filename)
• outDir : String, default: path.join(path.dirname(require.main.filename), 'docs')
• pkgJSON : String, default: path.join(path.dirname(require.main.filename), 'package.json')
• extension : String, default: 'js'

Usage

swintYUIDoc({
	name: 'myProject',
	inDir: path.join(__dirname, 'js'),
	outDir: path.join(__dirname, 'doc'),
	pkgJSON: path.join(__dirname, 'package.json'),
	extension: 'js'
}, function(err, results) {
	// ...
});