Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC release] Fix missing docs due to /* instead of /** #3601

Merged
merged 1 commit into from
Jul 30, 2015
Merged

[DOC release] Fix missing docs due to /* instead of /** #3601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions packages/ember-data/lib/serializers/json-api-serializer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ var dasherize = Ember.String.dasherize;
*/
export default JSONSerializer.extend({

/*
/**
@method _normalizeDocumentHelper
@param {Object} documentHash
@return {Object}
Expand All @@ -117,7 +117,7 @@ export default JSONSerializer.extend({
return documentHash;
},

/*
/**
@method _normalizeRelationshipDataHelper
@param {Object} relationshipDataHash
@return {Object}
Expand All @@ -129,7 +129,7 @@ export default JSONSerializer.extend({
return relationshipDataHash;
},

/*
/**
@method _normalizeResourceHelper
@param {Object} resourceHash
@return {Object}
Expand Down Expand Up @@ -169,7 +169,7 @@ export default JSONSerializer.extend({
return normalizedPayload;
},

/*
/**
@method extractAttributes
@param {DS.Model} modelClass
@param {Object} resourceHash
Expand All @@ -190,7 +190,7 @@ export default JSONSerializer.extend({
return attributes;
},

/*
/**
@method extractRelationship
@param {Object} relationshipHash
@return {Object}
Expand All @@ -208,7 +208,7 @@ export default JSONSerializer.extend({
return relationshipHash;
},

/*
/**
@method extractRelationships
@param {Object} modelClass
@param {Object} resourceHash
Expand All @@ -232,8 +232,8 @@ export default JSONSerializer.extend({
return relationships;
},

/*
@method extractType
/**
@method _extractType
@param {DS.Model} modelClass
@param {Object} resourceHash
@return {String}
Expand Down Expand Up @@ -261,7 +261,7 @@ export default JSONSerializer.extend({
return pluralize(modelName);
},

/*
/**
@method normalize
@param {DS.Model} modelClass
@param {Object} resourceHash
Expand Down
62 changes: 24 additions & 38 deletions packages/ember-data/lib/serializers/json-serializer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ var get = Ember.get;
var isNone = Ember.isNone;
var merge = Ember.merge;

/*
/**
Ember Data 2.0 Serializer:

In Ember Data a Serializer is used to serialize and deserialize
Expand All @@ -30,15 +30,18 @@ var merge = Ember.merge;
house: DS.belongsTo('location'),
});
```

```js
{ id: 1,
{
id: 1,
name: 'Sebastian',
friends: [3, 4],
links: {
house: '/houses/lefkada'
}
}
```

to JSONApi format that the Ember Data store expects.

You can customize how JSONSerializer processes it's payload by passing options in
Expand Down Expand Up @@ -66,23 +69,6 @@ var merge = Ember.merge;
@namespace DS
@extends DS.Serializer
*/

/**
In Ember Data a Serializer is used to serialize and deserialize
records when they are transferred in and out of an external source.
This process involves normalizing property names, transforming
attribute values and serializing relationships.

For maximum performance Ember Data recommends you use the
[RESTSerializer](DS.RESTSerializer.html) or one of its subclasses.

`JSONSerializer` is useful for simpler or legacy backends that may
not support the http://jsonapi.org/ spec.

@class JSONSerializer
@namespace DS
@extends DS.Serializer
*/
var JSONSerializer = Serializer.extend({

/**
Expand Down Expand Up @@ -197,7 +183,7 @@ var JSONSerializer = Serializer.extend({
return data;
},

/*
/**
The `normalizeResponse` method is used to normalize a payload from the
server to a JSON-API Document.

Expand Down Expand Up @@ -256,7 +242,7 @@ var JSONSerializer = Serializer.extend({
}
},

/*
/**
@method normalizeFindRecordResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -269,7 +255,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSingleResponse(...arguments);
},

/*
/**
@method normalizeQueryRecordResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -282,7 +268,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSingleResponse(...arguments);
},

/*
/**
@method normalizeFindAllResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -295,7 +281,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeArrayResponse(...arguments);
},

/*
/**
@method normalizeFindBelongsToResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -308,7 +294,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSingleResponse(...arguments);
},

/*
/**
@method normalizeFindHasManyResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -321,7 +307,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeArrayResponse(...arguments);
},

/*
/**
@method normalizeFindManyResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -334,7 +320,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeArrayResponse(...arguments);
},

/*
/**
@method normalizeQueryResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -347,7 +333,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeArrayResponse(...arguments);
},

/*
/**
@method normalizeCreateRecordResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -360,7 +346,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSaveResponse(...arguments);
},

/*
/**
@method normalizeDeleteRecordResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -373,7 +359,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSaveResponse(...arguments);
},

/*
/**
@method normalizeUpdateRecordResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -386,7 +372,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSaveResponse(...arguments);
},

/*
/**
@method normalizeSaveResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -399,7 +385,7 @@ var JSONSerializer = Serializer.extend({
return this.normalizeSingleResponse(...arguments);
},

/*
/**
@method normalizeSingleResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -412,7 +398,7 @@ var JSONSerializer = Serializer.extend({
return this._normalizeResponse(store, primaryModelClass, payload, id, requestType, true);
},

/*
/**
@method normalizeArrayResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand All @@ -425,7 +411,7 @@ var JSONSerializer = Serializer.extend({
return this._normalizeResponse(store, primaryModelClass, payload, id, requestType, false);
},

/*
/**
@method _normalizeResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand Down Expand Up @@ -524,7 +510,7 @@ var JSONSerializer = Serializer.extend({
return { data };
},

/*
/**
Returns the resource's ID.

@method extractId
Expand All @@ -538,7 +524,7 @@ var JSONSerializer = Serializer.extend({
return coerceId(id);
},

/*
/**
Returns the resource's attributes formatted as a JSON-API "attributes object".

http://jsonapi.org/format/#document-resource-object-attributes
Expand All @@ -562,7 +548,7 @@ var JSONSerializer = Serializer.extend({
return attributes;
},

/*
/**
Returns a relationship formatted as a JSON-API "relationship object".

http://jsonapi.org/format/#document-resource-object-relationships
Expand Down Expand Up @@ -591,7 +577,7 @@ var JSONSerializer = Serializer.extend({
return { id: coerceId(relationshipHash), type: relationshipModelName };
},

/*
/**
Returns the resource's relationships formatted as a JSON-API "relationships object".

http://jsonapi.org/format/#document-resource-object-relationships
Expand Down
4 changes: 2 additions & 2 deletions packages/ember-data/lib/serializers/rest-serializer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ var RESTSerializer = JSONSerializer.extend({
return this._super(modelClass, resourceHash, prop);
},

/*
/**
Normalizes an array of resource payloads and returns a JSON-API Document
with primary data and, if any, included data as `{ data, included }`.

Expand Down Expand Up @@ -159,7 +159,7 @@ var RESTSerializer = JSONSerializer.extend({
return documentHash;
},

/*
/**
@method _normalizeResponse
@param {DS.Store} store
@param {DS.Model} primaryModelClass
Expand Down