Make findAll and findQuery private in API docs.

emberjs · Dec 19, 2013 · ec2e040 · ec2e040
1 parent a040c71
commit ec2e040
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 13 deletions.
diff --git a/packages/ember-data/lib/adapters/fixture_adapter.js b/packages/ember-data/lib/adapters/fixture_adapter.js
@@ -149,6 +149,7 @@ DS.FixtureAdapter = DS.Adapter.extend({
   },
 
   /**
+    @private
     @method findAll
     @param  store
     @param  type
@@ -164,6 +165,7 @@ DS.FixtureAdapter = DS.Adapter.extend({
   },
 
   /**
+    @private
     @method findQuery
     @param  store
     @param  type

diff --git a/packages/ember-data/lib/adapters/rest_adapter.js b/packages/ember-data/lib/adapters/rest_adapter.js
@@ -139,6 +139,7 @@ DS.RESTAdapter = DS.Adapter.extend({
     The `findAll` method makes an Ajax (HTTP GET) request to a URL computed by `buildURL`, and returns a
     promise for the resulting payload.
 
+    @private
     @method findAll
     @see RESTAdapter/buildURL
     @see RESTAdapter/ajax
@@ -167,6 +168,7 @@ DS.RESTAdapter = DS.Adapter.extend({
     The `query` argument is a simple JavaScript object that will be passed directly
     to the server as parameters.
 
+    @private
     @method findQuery
     @see RESTAdapter/buildURL
     @see RESTAdapter/ajax

diff --git a/packages/ember-data/lib/system/adapter.js b/packages/ember-data/lib/system/adapter.js
@@ -75,25 +75,27 @@ DS.Adapter = Ember.Object.extend(DS._Mappable, {
 
     Here is an example `find` implementation:
 
-        find: function(store, type, id) {
-          var url = type.url;
-          url = url.fmt(id);
-
-          jQuery.getJSON(url, function(data) {
-              // data is a hash of key/value pairs. If your server returns a
-              // root, simply do something like:
-              // store.push(type, id, data.person)
-              store.push(type, id, data);
-          });
-        }
+    ```javascript
+    find: function(store, type, id) {
+      var url = type.url;
+      url = url.fmt(id);
+
+      jQuery.getJSON(url, function(data) {
+          // data is a hash of key/value pairs. If your server returns a
+          // root, simply do something like:
+          // store.push(type, id, data.person)
+          store.push(type, id, data);
+      });
+    }
+    ```
 
     @method find
   */
   find: Ember.required(Function),
 
   /**
-    Optional
 
+    @private
     @method findAll
     @param  store
     @param  type
@@ -102,8 +104,8 @@ DS.Adapter = Ember.Object.extend(DS._Mappable, {
   findAll: null,
 
   /**
-    Optional
 
+    @private
     @method findQuery
     @param  store
     @param  type