Documentation cleanup

This commit is contained in:
Ritchie Martori 2014-04-14 14:49:29 -07:00
parent 940e11125d
commit 13b18065e2
4 changed files with 20 additions and 4 deletions

View File

@ -12,6 +12,7 @@
"lib/models/application.js",
"lib/models/email.js",
"lib/models/model.js",
"lib/models/data-model.js",
"lib/models/role.js",
"lib/models/user.js",
"docs/api-datasource.md",

View File

@ -7,8 +7,19 @@ var DataAccess = require('loopback-datasource-juggler/lib/dao');
/**
* Extends Model with basic query and CRUD support.
*
* **Change Event**
*
* Listen for model changes using the `change` event.
*
* ```js
* MyDataModel.on('changed', function(obj) {
* console.log(obj) // => the changed model
* });
* ```
*
* @class DataModel
* @param {Object} data
* @param {Number} data.id The default id property
*/
var DataModel = module.exports = Model.extend('DataModel');

View File

@ -16,7 +16,7 @@ var RoleSchema = {
modified: {type: Date, default: Date}
};
/**
/*!
* Map principals to roles
*/
var RoleMappingSchema = {
@ -27,7 +27,10 @@ var RoleMappingSchema = {
};
/**
* Map Roles to
* The `RoleMapping` model extends from the built in `loopback.Model` type.
*
* @class
* @inherits {Model}
*/
var RoleMapping = loopback.createModel('RoleMapping', RoleMappingSchema, {

View File

@ -1,4 +1,4 @@
/**
/*!
* Module Dependencies.
*/
@ -19,7 +19,8 @@ var Model = require('../loopback').Model
, assert = require('assert');
var debug = require('debug')('loopback:user');
/**
/*!
* Default User properties.
*/