Skip to content

Commit

Permalink
adding deprecation warnings the right way for attributes and setter
Browse files Browse the repository at this point in the history
  • Loading branch information
moschel committed May 5, 2014
1 parent bb94071 commit f6abe2a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
9 changes: 6 additions & 3 deletions map/attributes/doc/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@
@group can.Map.attributes.static static
@group can.Map.attributes.prototype prototype

@body

## Deprecation Warning
@deprecated {2.1} The attributes plugin (and the setter plugin) have been deprecated in
favor of the new [can.Map.prototype.define define] plugin, which provides the same
functionality. It will still be maintained up to 3.0 and potentially after.
Projects using converters or serializers should consider switching to [can.Map.prototype.define.type define's type]
and [can.Map.prototype.define.serialize define's serialize].

The attributes plugin (and the setter plugin) has been deprecated in 2.1 in favor of the new [can.Map.prototype.define define] plugin, which provides the same functionality.
@body

## Use

Expand Down
9 changes: 5 additions & 4 deletions map/setter/doc/setter.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

Specify setter methods on [can.Map can.Maps].

@deprecated {2.1} The setter plugin (and the attributes plugin) have been deprecated in
favor of the new [can.Map.prototype.define define] plugin, which provides the same
functionality. It will still be maintained up to 3.0 and potentially after.
Projects using setters should consider switching to [can.Map.prototype.define.set define setters].

@signature `setATTR: function(newValue,setValue,setErrors)`

Specifies a setter method for the `ATTR` attribute.
Expand All @@ -25,10 +30,6 @@ set undefined values.

@body

## Deprecation Warning

The attributes plugin (and the setter plugin) has been deprecated in 2.1 in favor of the new [can.Map.prototype.define define] plugin, which provides the same functionality.

## Use

`can.Map.setter(name, setValue(value), setErrors(errors))` extends the Map object
Expand Down

0 comments on commit f6abe2a

Please sign in to comment.