aboutsummaryrefslogtreecommitdiffstats
path: root/src/formatters.js
diff options
context:
space:
mode:
authorIgor Minar2010-11-17 12:13:04 -0800
committerIgor Minar2010-11-18 02:34:53 -0800
commit4c69d694d75f01cffbc75be331b5636068a41048 (patch)
treec2dd23dc6813c9ab9baaea50f025908f1be001fc /src/formatters.js
parentff7c738c21075f834b5f610085d195cfa1eb5110 (diff)
downloadangular.js-4c69d694d75f01cffbc75be331b5636068a41048.tar.bz2
make @returns type non-optional
Diffstat (limited to 'src/formatters.js')
-rw-r--r--src/formatters.js8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/formatters.js b/src/formatters.js
index 38175d7d..85be7019 100644
--- a/src/formatters.js
+++ b/src/formatters.js
@@ -38,7 +38,7 @@ angularFormatter.json = formatter(toJson, fromJson);
* @description
* Use boolean formatter if you wish to store the data as boolean.
*
- * @returns Convert to `true` unless user enters (blank), `f`, `false`, `0`, `no`, `[]`.
+ * @returns {boolean} Converts to `true` unless user enters (blank), `f`, `false`, `0`, `no`, `[]`.
*
* @example
* Enter truthy text:
@@ -62,7 +62,7 @@ angularFormatter['boolean'] = formatter(toString, toBoolean);
* @description
* Use number formatter if you wish to convert the user entered string to a number.
*
- * @returns parse string to number.
+ * @returns {number} Number from the parsed string.
*
* @example
* Enter valid number:
@@ -89,9 +89,9 @@ angularFormatter.number = formatter(toString, function(obj){
* @name angular.formatter.list
*
* @description
- * Use number formatter if you wish to convert the user entered string to a number.
+ * Use list formatter if you wish to convert the user entered string to an array.
*
- * @returns parse string to number.
+ * @returns {Array} Array parsed from the entered string.
*
* @example
* Enter a list of items: