Fixed up JS Doc

This commit is contained in:
Rand McKinney 2014-10-08 15:07:03 -07:00
parent 6de9645f45
commit 7aca64a660
1 changed files with 16 additions and 16 deletions

View File

@ -1,4 +1,4 @@
/**
/*!
* Module Dependencies.
*/
@ -10,7 +10,7 @@ var PersistedModel = require('./persisted-model')
, assert = require('assert')
, debug = require('debug')('loopback:change');
/**
/*!
* Properties
*/
@ -23,7 +23,7 @@ var properties = {
modelId: {type: String}
};
/**
/*!
* Options
*/
@ -34,12 +34,12 @@ var options = {
/**
* Change list entry.
*
* @property id {String} Hash of the modelName and id
* @property rev {String} the current model revision
* @property prev {String} the previous model revision
* @property checkpoint {Number} the current checkpoint at time of the change
* @property modelName {String} the model name
* @property modelId {String} the model id
* @property {String} id Hash of the modelName and id
* @property {String} rev The current model revision
* @property {String} prev The previous model revision
* @property {Number} checkpoint The current checkpoint at time of the change
* @property {String} modelName Model name
* @property {String} modelId Model ID
*
* @class
* @inherits {Model}
@ -515,7 +515,7 @@ function Conflict(modelId, SourceModel, TargetModel) {
* Fetch the conflicting models.
*
* @callback {Function} callback
* @param {Error}
* @param {Error} err
* @param {PersistedModel} source
* @param {PersistedModel} target
*/
@ -618,12 +618,12 @@ Conflict.prototype.resolve = function(cb) {
/**
* Determine the conflict type.
*
* ```js
* // possible results are
* Change.UPDATE // => source and target models were updated
* Change.DELETE // => the source and or target model was deleted
* Change.UNKNOWN // => the conflict type is uknown or due to an error
* ```
* Possible results are
*
* - `Change.UPDATE`: Source and target models were updated.
* - `Change.DELETE`: Source and or target model was deleted.
* - `Change.UNKNOWN`: the conflict type is uknown or due to an error.
*
* @callback {Function} callback
* @param {Error} err
* @param {String} type The conflict type.