不要怂,就是干,撸起袖子干!

Commit 6cadd2e7 by Sascha Depold

adjustments for yuidoc

1 parent be10f0bc
Showing with 24 additions and 12 deletions
/**
The entry point.
@module sequelize
**/
module.exports = require("./lib/sequelize") module.exports = require("./lib/sequelize")
...@@ -10,20 +10,28 @@ if (typeof process != 'undefined' && parseFloat(process.version.replace('v', '') ...@@ -10,20 +10,28 @@ if (typeof process != 'undefined' && parseFloat(process.version.replace('v', '')
module.exports = (function() { module.exports = (function() {
/** /**
Main constructor of the project. Main class of the project.
Params: @param {String} database The name of the database.
@param {String} username The username which is used to authenticate against the database.
@param {String} [password] The password which is used to authenticate against the database.
@param {Object} [options] An object with options.
- `database` @example
- `username` // without password and options
- `password`, optional, default: null var sequelize = new Sequelize('database', 'username')
- `options`, optional, default: {}
Examples: // without options
var sequelize = new Sequelize('database', 'username', 'password')
mymodule.write('foo') // without password / with blank password
mymodule.write('foo', { stream: process.stderr }) var sequelize = new Sequelize('database', 'username', null, {})
// with password and options
var sequelize = new Sequelize('my_database', 'john', 'doe', {})
@class Sequelize
@constructor
*/ */
var Sequelize = function(database, username, password, options) { var Sequelize = function(database, username, password, options) {
this.options = Utils._.extend({ this.options = Utils._.extend({
......
...@@ -36,8 +36,8 @@ ...@@ -36,8 +36,8 @@
"mysql": "~2.0.0-alpha3", "mysql": "~2.0.0-alpha3",
"pg": "~0.10.2", "pg": "~0.10.2",
"buster": "~0.6.0", "buster": "~0.6.0",
"dox-foundation": "~0.3.0", "watchr": "~2.2.0",
"watchr": "~2.2.0" "yuidocjs": "~0.3.36"
}, },
"keywords": [ "keywords": [
"mysql", "mysql",
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
"test-buster-postgres": "DIALECT=postgres ./node_modules/.bin/buster-test", "test-buster-postgres": "DIALECT=postgres ./node_modules/.bin/buster-test",
"test-buster-postgres-native": "DIALECT=postgres-native ./node_modules/.bin/buster-test", "test-buster-postgres-native": "DIALECT=postgres-native ./node_modules/.bin/buster-test",
"test-buster-sqlite": "DIALECT=sqlite ./node_modules/.bin/buster-test", "test-buster-sqlite": "DIALECT=sqlite ./node_modules/.bin/buster-test",
"generate-docs": "node_modules/.bin/dox-foundation --source ./lib --target ./docs --title Sequelize" "docs": "node_modules/.bin/yuidoc . -o docs"
}, },
"bin": { "bin": {
"sequelize": "bin/sequelize" "sequelize": "bin/sequelize"
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!