dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 3817
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2
timestamp: Wed 2011-06-01 10:19:02 +0200
message:
  minor doc fixes
modified:
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.array.js
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.comparator.js
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.select.js
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.util.js


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription

=== modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.array.js'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.array.js	2011-05-31 09:30:22 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.array.js	2011-06-01 08:19:02 +0000
@@ -30,9 +30,11 @@
 /**
  * Remove part of an array.
  * 
- * @param array {array} Array to remove from
+ * @param array {Array} Array to remove from
  * @param from {Number} Start index
  * @param to {Number} End index
+ * 
+ * @returns {Array}Â Array without the removed parts
  */
 dhis2.array.remove = function( array, from, to )
 {

=== modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.comparator.js'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.comparator.js	2011-05-31 09:30:22 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.comparator.js	2011-06-01 08:19:02 +0000
@@ -30,8 +30,8 @@
 /**
  * Compares two objects and returns result.
  * 
- * @param a {object}
- * @param b {object}
+ * @param a {object} Object A
+ * @param b {object} Object B
  * 
  * @returns {Number} 1 if a>b, -1 if a>b, 0 if equal
  */
@@ -47,8 +47,8 @@
 /**
  * Case sensitive compare of two jQuery objects (based on their innerHTML).
  * 
- * @param a A jQuery wrapped object
- * @param b A jQuery wrapped object
+ * @param a {jQuery} Object A
+ * @param b {jQuery} Object B
  * 
  * @returns {Number} 1 if a>b, -1 if a>b, 0 if equal
  */
@@ -60,8 +60,8 @@
 /**
  * Case insensitive compare of two jQuery objects (based on their innerHTML).
  * 
- * @param a A jQuery wrapped object
- * @param b A jQuery wrapped object
+ * @param a {jQuery} Object A
+ * @param b {jQuery} Object B
  * 
  * @returns {Number} 1 if a>b, -1 if a>=b
  */

=== modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.select.js'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.select.js	2011-06-01 08:15:30 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.select.js	2011-06-01 08:19:02 +0000
@@ -32,6 +32,7 @@
  * can't be hidden using 'display: none' or other similar techniques.
  * 
  * @param $select {jQuery}Â The select to ghost
+ * 
  * @returns The ghost for a given select
  */
 dhis2.select.getGhost = function( $select )

=== modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.util.js'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.util.js	2011-05-31 09:30:22 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.util.js	2011-06-01 08:19:02 +0000
@@ -32,6 +32,7 @@
  * Creates namespace object based on path
  * 
  * @param path {String}Â The path of the namespace, i.e. 'a.b.c'
+ * 
  * @returns {object} Namespace object
  */
 dhis2.util.namespace = function( path )