Updated documentation

canjs · Aug 18, 2017 · 5ee6d2e · 5ee6d2e
1 parent dc3e77c
commit 5ee6d2e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/list/list.js b/list/list.js
@@ -295,6 +295,8 @@ var DefineList = Construct.extend("DefineList",
 		 * list.assign({count: 1000, skip: 2});
 		 * list.get("count") //-> 1000
 		 * ```
+		 *   @param {Array} newProps Properties that need to be assigned to the list instance
+		 *   @return {can-define/list/list} The list instance.
 		 */
 		assign: function(prop) {
 			if (canReflect.isListLike(prop)) {
@@ -321,6 +323,8 @@ var DefineList = Construct.extend("DefineList",
 		 * list.get("count") //-> 1000
 		 * list.get("skip") //-> undefined
 		 * ```
+		 *   @param {Array} newProps Properties that need to be updated to the list instance
+		 *   @return {can-define/list/list} The list instance.
 		 */
 		update: function(prop) {
 			if (canReflect.isListLike(prop)) {
@@ -349,6 +353,9 @@ var DefineList = Construct.extend("DefineList",
 		 * list.get("count") //-> 1000
 		 * list.get("skip") //-> 2
 		 * ```
+		 *
+		 *   @param {Array} newProps Properties that need to be assigned to the list instance
+		 *   @return {can-define/list/list} The list instance.
 		 */
 		assignDeep: function(prop) {
 			if (canReflect.isListLike(prop)) {
@@ -377,6 +384,8 @@ var DefineList = Construct.extend("DefineList",
 		 * list.get("skip") //-> undefined
 		 * list.get("foo") // -> {bar: 'yay', a: undefined}
 		 * ```
+		 *   @param {Array} newProps Properties that need to be updated on the list instance
+		 *   @return {can-define/list/list} The list instance.
 		 */
 		updateDeep: function(prop) {
 			if (canReflect.isListLike(prop)) {

diff --git a/map/map.js b/map/map.js
@@ -210,9 +210,6 @@ var DefineMap = Construct.extend("DefineMap",{
 	 * corresponding key in `props`, effectively replacing `props` into the Map.
 	 * Properties not in `props` will not be changed.
 	 *
-	 *   @param {Object} props A collection of key-value pairs to set.
-	 *   If any properties already exist on the map, they will be overwritten.
-	 *
 	 * ```js
 	 * var MyMap = DefineMap.extend({
 	 * 	list: DefineList,
@@ -229,6 +226,9 @@ var DefineMap = Construct.extend("DefineMap",{
 	 * obj.list //-> ['first']
 	 * obj.foo //-> 'bar'
 	 * ```
+	 *   @param {Object} props A collection of key-value pairs to set.
+	 *   If any properties already exist on the map, they will be overwritten.
+	 *
 	 *   @return {can-define/map/map} The map instance for chaining.
 	 *
 	 */