Skip to content

Commit

Permalink
Merge pull request #4052 from pangratz/make-internal-model-private-in…
Browse files Browse the repository at this point in the history
…-docs

[DOC beta] Hide private classes from YUIDoc
  • Loading branch information
bmac committed Jan 9, 2016
2 parents 9255531 + c214990 commit e926b26
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 22 deletions.
2 changes: 1 addition & 1 deletion addon/-private/system/container-proxy.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { deprecate } from "ember-data/-private/debug";

/**
/*
This is used internally to enable deprecation of container paths and provide
a decent message to the user indicating how to fix the issue.
Expand Down
2 changes: 1 addition & 1 deletion addon/-private/system/debug/debug-adapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ var capitalize = Ember.String.capitalize;
var underscore = Ember.String.underscore;
const { assert } = Ember;

/**
/*
Extend `Ember.DataAdapter` with ED specific code.
@class DebugAdapter
Expand Down
41 changes: 21 additions & 20 deletions addon/-private/system/model/internal-model.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function retrieveFromCurrentState(key) {
}

var guid = 0;
/**
/*
`InternalModel` is the Model class that we use internally inside Ember Data to represent models.
Internal ED methods should only deal with `InternalModel` objects. It is a fast, plain Javascript class.
Expand All @@ -57,6 +57,7 @@ var guid = 0;
We need to make sure that the properties from `InternalModel` are correctly exposed/proxied on `Model`
if they are needed.
@private
@class InternalModel
*/

Expand Down Expand Up @@ -247,15 +248,15 @@ InternalModel.prototype = {
}
},

/**
/*
@method createSnapshot
@private
*/
createSnapshot(options) {
return new Snapshot(this, options);
},

/**
/*
@method loadingData
@private
@param {Promise} promise
Expand All @@ -264,7 +265,7 @@ InternalModel.prototype = {
this.send('loadingData', promise);
},

/**
/*
@method loadedData
@private
*/
Expand All @@ -273,15 +274,15 @@ InternalModel.prototype = {
this.didInitalizeData();
},

/**
/*
@method notFound
@private
*/
notFound() {
this.send('notFound');
},

/**
/*
@method pushedData
@private
*/
Expand All @@ -298,7 +299,7 @@ InternalModel.prototype = {
return Object.keys(this._attributes).length > 0;
},

/**
/*
Checks if the attributes which are considered as changed are still
different to the state which is acknowledged by the server.
Expand All @@ -322,7 +323,7 @@ InternalModel.prototype = {
}
},

/**
/*
Returns an object, whose keys are changed properties, and value is an
[oldProp, newProp] array.
Expand All @@ -346,15 +347,15 @@ InternalModel.prototype = {
return diffData;
},

/**
/*
@method adapterWillCommit
@private
*/
adapterWillCommit() {
this.send('willCommit');
},

/**
/*
@method adapterDidDirty
@private
*/
Expand All @@ -363,7 +364,7 @@ InternalModel.prototype = {
this.updateRecordArraysLater();
},

/**
/*
@method send
@private
@param {String} name
Expand Down Expand Up @@ -434,7 +435,7 @@ InternalModel.prototype = {
this.record._notifyProperties(dirtyKeys);

},
/**
/*
@method transitionTo
@private
@param {String} name
Expand Down Expand Up @@ -520,7 +521,7 @@ InternalModel.prototype = {

this._deferredTriggers.length = 0;
},
/**
/*
@method clearRelationships
@private
*/
Expand All @@ -538,7 +539,7 @@ InternalModel.prototype = {
});
},

/**
/*
When a find request is triggered on the store, the user can optionally pass in
attributes and relationships to be preloaded. These are meant to behave as if they
came back from the server, except the user obtained them out of band and is informing
Expand Down Expand Up @@ -608,7 +609,7 @@ InternalModel.prototype = {
return value;
},

/**
/*
@method updateRecordArrays
@private
*/
Expand Down Expand Up @@ -648,7 +649,7 @@ InternalModel.prototype = {
});
}
},
/**
/*
If the adapter did not return a hash in response to a commit,
merge the changed attributes and relationships into the existing
saved data.
Expand Down Expand Up @@ -678,7 +679,7 @@ InternalModel.prototype = {
this.record._notifyProperties(changedKeys);
},

/**
/*
@method updateRecordArraysLater
@private
*/
Expand Down Expand Up @@ -713,7 +714,7 @@ InternalModel.prototype = {

// FOR USE DURING COMMIT PROCESS

/**
/*
@method adapterDidInvalidate
@private
*/
Expand All @@ -731,7 +732,7 @@ InternalModel.prototype = {
this._saveWasRejected();
},

/**
/*
@method adapterDidError
@private
*/
Expand All @@ -751,7 +752,7 @@ InternalModel.prototype = {
this._inFlightAttributes = new EmptyObject();
},

/**
/*
Ember Data has 3 buckets for storing the value of an attribute on an internalModel.
`_data` holds all of the attributes that have been acknowledged by
Expand Down

0 comments on commit e926b26

Please sign in to comment.