Added class properties jsdoc.
This commit is contained in:
parent
8d851e8b5f
commit
6de9645f45
|
@ -14,16 +14,12 @@ var properties = {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The Email Model.
|
* @property {String} to Email addressee. Required.
|
||||||
|
* @property {String} from Email sender address. Required.
|
||||||
|
* @property {String} subject Email subject string. Required.
|
||||||
|
* @property {String} text Text body of email.
|
||||||
|
* @property {String} html HTML body of email.
|
||||||
*
|
*
|
||||||
* **Properties**
|
|
||||||
*
|
|
||||||
* - `to` - String (required)
|
|
||||||
* - `from` - String (required)
|
|
||||||
* - `subject` - String (required)
|
|
||||||
* - `text` - String
|
|
||||||
* - `html` - String
|
|
||||||
*
|
|
||||||
* @class
|
* @class
|
||||||
* @inherits {Model}
|
* @inherits {Model}
|
||||||
*/
|
*/
|
||||||
|
@ -58,4 +54,4 @@ var Email = module.exports = Model.extend('Email', properties);
|
||||||
|
|
||||||
Email.prototype.send = function() {
|
Email.prototype.send = function() {
|
||||||
throw new Error('You must connect the Email Model to a Mail connector');
|
throw new Error('You must connect the Email Model to a Mail connector');
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue