dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 15171
committer: Morten Olav Hansen <mortenoh@xxxxxxxxx>
branch nick: dhis2
timestamp: Tue 2014-05-06 16:46:20 +0700
message:
  minor jsdoc updates
modified:
  dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.period.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.period.js'
--- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.period.js	2014-05-06 06:33:45 +0000
+++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/javascripts/dhis2/dhis2.period.js	2014-05-06 09:46:20 +0000
@@ -78,7 +78,7 @@
 /**
  * Creates a date picker.
  *
- * @param el Element to select on, can be any kind of jQuery selector, or a jqEl
+ * @param {jQuery|String|Object} el Element to select on, can be any kind of jQuery selector, or a jqEl
  * @param fromIso Convert field from ISO 8601 to local calendar
  * @param options Additional options, will be merged with the defaults
  */
@@ -98,8 +98,8 @@
 /**
  * Creates a ranged date picker, keeping two fields in sync.
  *
- * @param {*} fromEl From element to select on, can be any kind of jQuery selector, or a jqEl
- * @param {*} toEl To element to select on, can be any kind of jQuery selector, or a jqEl
+ * @param {jQuery|String|Object} fromEl From element to select on, can be any kind of jQuery selector, or a jqEl
+ * @param {jQuery|String|Object} toEl To element to select on, can be any kind of jQuery selector, or a jqEl
  * @param {Boolean} fromIso Convert fields from ISO 8601 to local calendar
  * @param {Object} options Additional options, will be merged with the defaults
  */
@@ -179,6 +179,7 @@
 
 /**
  * Registers a new generator, must be of instance of dhis2.period.BaseGenerator
+ *
  * @param {*} klass Class to register, will be checked for type
  * @see dhis2.period.BaseGenerator
  */
@@ -318,7 +319,8 @@
 };
 
 /**
- * Does out-of-place reversal of a list of periods
+ * Out-of-place reversal of a list of periods
+ *
  * @param {Array} periods Periods to reverse
  * @returns {Array} Reversed array
  */
@@ -328,6 +330,7 @@
 
 /**
  * Out-of-place filtering of current + future periods
+ *
  * @param {Array} periods Periods to filter
  * @return {Array} Filtered periods array
  */
@@ -346,6 +349,7 @@
 
 /**
  * Out-of-place filtering of future periods
+ *
  * @param {Array} periods Periods to filter
  * @return {Array} Filtered periods array
  */
@@ -364,6 +368,7 @@
 
 /**
  * Base class for generator classes, should not be instantiated directly.
+ *
  * @param {String} name Name of generator
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
@@ -386,6 +391,7 @@
 $.extend(dhis2.period.BaseGenerator.prototype, {
   /**
    * Generate periods from a year offset (offset from current year)
+   *
    * @param {int=} offset Year to generate from, offset from current year (default 0)
    * @return {Array} Generated periods using selected offset
    * @access public
@@ -395,7 +401,8 @@
     return this.$generate(offset);
   },
   /**
-   * @param {int=} offset Year to generate from, offset from current year (default 0)
+   * @param {int} offset Year to generate from, offset from current year (default 0)
+   *
    * @return {Array} Generated periods using selected offset
    * @abstract
    * @access protected
@@ -407,6 +414,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates Daily periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -448,6 +456,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates Weekly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -500,6 +509,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates Monthly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -540,6 +550,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates BiMonthly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -581,6 +592,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates Quarterly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -622,6 +634,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates SixMonthly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -677,6 +690,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates SixMonthlyApril periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -732,6 +746,7 @@
 
 /**
  * Implementation of dhis2.period.BaseGenerator that generates Yearly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -774,6 +789,7 @@
 
 /**
  * Base class for financial monthly offset generator classes, should not be instantiated directly.
+ *
  * @param {String} name Name of generator
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
@@ -825,6 +841,7 @@
 
 /**
  * Implementation of dhis2.period.FinancialBaseGenerator that generates FinancialApril periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -840,6 +857,7 @@
 
 /**
  * Implementation of dhis2.period.FinancialBaseGenerator that generates FinancialJuly periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor
@@ -855,6 +873,7 @@
 
 /**
  * Implementation of dhis2.period.FinancialBaseGenerator that generates FinancialOctober periods
+ *
  * @param {$.calendars.baseCalendar} calendar Calendar to use, this must come from $.calendars.instance(chronology).
  * @param {String} format Date format to use for formatting, will default to ISO 8601
  * @constructor