diff --git a/lib/relations.js b/lib/relations.js index 81495170..c07b87d2 100644 --- a/lib/relations.js +++ b/lib/relations.js @@ -92,7 +92,7 @@ function lookupModel(models, modelName) { *``` * @param {Object|String} anotherClass Model object (or String name of model) to which you are creating the relationship. * @options {Object} parameters Configuration parameters; see below. - * @property {String} as + * @property {String} as Name of the property in the referring model that corresponds to the foreign key field in the related model. * @property {String} foreignKey Property name of foreign key field. * @property {Object} model Model object */ @@ -166,9 +166,9 @@ Relation.hasMany = function hasMany(anotherClass, params) { }); }; - /** + /*! * Add the target model instance to the 'hasMany' relation - * @param {Object|ID) acInst The actual instance or id value + * @param {Object|ID} acInst The actual instance or id value */ scopeMethods.add = function (acInst, done) { var data = {}; @@ -181,7 +181,7 @@ Relation.hasMany = function hasMany(anotherClass, params) { params.through.findOrCreate({where: query}, data, done); }; - /** + /*! * Remove the target model instance from the 'hasMany' relation * @param {Object|ID) acInst The actual instance or id value */ @@ -306,7 +306,7 @@ Relation.hasMany = function hasMany(anotherClass, params) { * * @param {Class|String} anotherClass Model object (or String name of model) to which you are creating the relationship. * @options {Object} params Configuration parameters; see below. - * @property {String} as Can be 'propertyName' + * @property {String} as Name of the property in the referring model that corresponds to the foreign key field in the related model. * @property {String} foreignKey Name of foreign key property. * */ @@ -478,7 +478,7 @@ Relation.belongsTo = function (anotherClass, params) { * @param {String|Object} anotherClass Model object (or String name of model) to which you are creating the relationship. * the relation * @options {Object} params Configuration parameters; see below. - * @property {String} as + * @property {String} as Name of the property in the referring model that corresponds to the foreign key field in the related model. * @property {String} foreignKey Property name of foreign key field. * @property {Object} model Model object */