Skip to content

Commit 5a8f3cb

Browse files
authored
[DOC release] Merge pull request #14341 from ziggythehamster/doc-ember-route-since
Add @SInCE doc tags to everything in Ember.Route that didn't already have it
2 parents 4a96d35 + 1be5253 commit 5a8f3cb

File tree

1 file changed

+22
-0
lines changed
  • packages/ember-routing/lib/system

1 file changed

+22
-0
lines changed

packages/ember-routing/lib/system/route.js

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export function hasDefaultSerialize(route) {
8080
@extends Ember.Object
8181
@uses Ember.ActionHandler
8282
@uses Ember.Evented
83+
@since 1.0.0
8384
@public
8485
*/
8586
let Route = EmberObject.extend(ActionHandler, Evented, {
@@ -123,6 +124,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
123124
@property queryParams
124125
@for Ember.Route
125126
@type Object
127+
@since 1.6.0
126128
@public
127129
*/
128130
queryParams: {},
@@ -137,6 +139,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
137139
@property routeName
138140
@for Ember.Route
139141
@type String
142+
@since 1.0.0
140143
@public
141144
*/
142145

@@ -381,6 +384,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
381384
@method paramsFor
382385
@param {String} name
383386
@return {Object} hash containing the parameters of the route `name`
387+
@since 1.4.0
384388
@public
385389
*/
386390
paramsFor(name) {
@@ -609,6 +613,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
609613
610614
@event willTransition
611615
@param {Transition} transition
616+
@since 1.0.0
612617
@public
613618
*/
614619

@@ -716,6 +721,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
716721
@event error
717722
@param {Error} error
718723
@param {Transition} transition
724+
@since 1.0.0
719725
@public
720726
*/
721727

@@ -897,6 +903,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
897903
not executed when the model for the route changes.
898904
899905
@method deactivate
906+
@since 1.0.0
900907
@public
901908
*/
902909
deactivate: K,
@@ -906,6 +913,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
906913
when the model for the route changes.
907914
908915
@method activate
916+
@since 1.0.0
909917
@public
910918
*/
911919
activate: K,
@@ -1062,6 +1070,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
10621070
containing a mapping of query parameters
10631071
@return {Transition} the transition object associated with this
10641072
attempted transition
1073+
@since 1.0.0
10651074
@public
10661075
*/
10671076
transitionTo(name, context) {
@@ -1146,6 +1155,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
11461155
transitioning to the route.
11471156
@return {Transition} the transition object associated with this
11481157
attempted transition
1158+
@since 1.0.0
11491159
@public
11501160
*/
11511161
replaceWith() {
@@ -1186,6 +1196,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
11861196
@method send
11871197
@param {String} name the name of the action to trigger
11881198
@param {...*} args
1199+
@since 1.0.0
11891200
@public
11901201
*/
11911202
send(...args) {
@@ -1354,6 +1365,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
13541365
a promise, the transition will pause until the transition
13551366
resolves. Otherwise, non-promise return values are not
13561367
utilized in any way.
1368+
@since 1.0.0
13571369
@public
13581370
*/
13591371
beforeModel: K,
@@ -1388,6 +1400,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
13881400
a promise, the transition will pause until the transition
13891401
resolves. Otherwise, non-promise return values are not
13901402
utilized in any way.
1403+
@since 1.0.0
13911404
@public
13921405
*/
13931406
afterModel: K,
@@ -1415,6 +1428,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
14151428
@method redirect
14161429
@param {Object} model the model for this route
14171430
@param {Transition} transition the transition object associated with the current transition
1431+
@since 1.0.0
14181432
@public
14191433
*/
14201434
redirect: K,
@@ -1499,6 +1513,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
14991513
a promise is returned, the transition will pause until
15001514
the promise resolves, and the resolved value of the promise
15011515
will be used as the model for this route.
1516+
@since 1.0.0
15021517
@public
15031518
*/
15041519
model(params, transition) {
@@ -1625,6 +1640,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
16251640
@param {Array} params an Array of parameter names for the current
16261641
route (in the example, `['post_id']`.
16271642
@return {Object} the serialized parameters
1643+
@since 1.0.0
16281644
@public
16291645
*/
16301646
serialize: defaultSerialize,
@@ -1688,6 +1704,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
16881704
@method setupController
16891705
@param {Controller} controller instance
16901706
@param {Object} model
1707+
@since 1.0.0
16911708
@public
16921709
*/
16931710
setupController(controller, context, transition) {
@@ -1714,6 +1731,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
17141731
@method controllerFor
17151732
@param {String} name the name of the route or controller
17161733
@return {Ember.Controller}
1734+
@since 1.0.0
17171735
@public
17181736
*/
17191737
controllerFor(name, _skipAssert) {
@@ -1791,6 +1809,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
17911809
@method modelFor
17921810
@param {String} name the name of the route
17931811
@return {Object} the model object
1812+
@since 1.0.0
17941813
@public
17951814
*/
17961815
modelFor(_name) {
@@ -1849,6 +1868,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
18491868
@method renderTemplate
18501869
@param {Object} controller the route's controller
18511870
@param {Object} model the route's model
1871+
@since 1.0.0
18521872
@public
18531873
*/
18541874
renderTemplate(controller, model) {
@@ -1971,6 +1991,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
19711991
referenced by name or as a controller instance. Defaults to the Route's paired controller
19721992
@param {Object} [options.model] the model object to set on `options.controller`.
19731993
Defaults to the return value of the Route's model hook
1994+
@since 1.0.0
19741995
@public
19751996
*/
19761997
render(_name, options) {
@@ -2034,6 +2055,7 @@ let Route = EmberObject.extend(ActionHandler, Evented, {
20342055
20352056
@method disconnectOutlet
20362057
@param {Object|String} options the options hash or outlet name
2058+
@since 1.0.0
20372059
@public
20382060
*/
20392061
disconnectOutlet(options) {

0 commit comments

Comments
 (0)