[Objectlabkit-svn] SF.net SVN: objectlabkit: [187] trunk/datecalc-jdk/src/main/java/net/ objectlab/kit/datecalc/jdk

[<be...@us...>]

Revision: 187
          http://svn.sourceforge.net/objectlabkit/?rev=187&view=rev
Author:   benoitx
Date:     2006-09-19 02:58:18 -0700 (Tue, 19 Sep 2006)

Log Message:
-----------
javadoc corrections, based on the yDoc warning report.

Modified Paths:
--------------
    trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarIMMDateCalculator.java
    trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarKitCalculatorsFactory.java

Modified: trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarIMMDateCalculator.java
===================================================================
--- trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarIMMDateCalculator.java	2006-09-19 09:52:41 UTC (rev 186)
+++ trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarIMMDateCalculator.java	2006-09-19 09:58:18 UTC (rev 187)
@@ -123,8 +123,7 @@
     /**
      * Assumes that the month is correct, get the day for the 3rd wednesday.
      * 
-     * @param first
-     * @return
+     * @param cal 
      */
     private void moveToIMMDay(final Calendar cal) {
         cal.set(Calendar.DAY_OF_MONTH, 1);

Modified: trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarKitCalculatorsFactory.java
===================================================================
--- trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarKitCalculatorsFactory.java	2006-09-19 09:52:41 UTC (rev 186)
+++ trunk/datecalc-jdk/src/main/java/net/objectlab/kit/datecalc/jdk/CalendarKitCalculatorsFactory.java	2006-09-19 09:58:18 UTC (rev 187)
@@ -47,8 +47,17 @@
     }
 
     /**
-     * @see net.objectlab.kit.datecalc.jdk.JdkDateCalculatorFactory#getDateCalculator(java.lang.String,
-     *      java.lang.String)
+     * Create a new DateCalculator for a given name and type of handling.
+     * 
+     * @param name
+     *            calendar name (holidays set interested in). If there is set of
+     *            holidays with that name, it will return a DateCalculator with
+     *            an empty holiday set (will work on Weekend only).
+     * @param holidayHandlerType
+     *            typically one of the value of HolidayHandlerType or null.
+     * @return a new DateCalculator
+     * @exception IllegalArgumentException
+     *                if the type is not null or a valid value.
      */
     public DateCalculator<Calendar> getDateCalculator(final String name, final String holidayHandlerType) {
         final CalendarDateCalculator cal = new CalendarDateCalculator();
@@ -73,17 +82,20 @@
     }
 
     /**
-     * @see net.objectlab.kit.datecalc.jdk.JdkDateCalculatorFactory#getPeriodCountCalculator()
+     * Create a new PeriodCountCalculator.
+     * 
+     * @return a PeriodCountCalculator
      */
     public PeriodCountCalculator<Calendar> getPeriodCountCalculator() {
         return PCC;
     }
 
     /**
-     * @see net.objectlab.kit.datecalc.jdk.JdkDateCalculatorFactory#getIMMDateCalculator()
+     * Create a new IMMDateCalculator.
+     * 
+     * @return an IMMDateCalculator
      */
     public IMMDateCalculator<Calendar> getIMMDateCalculator() {
         return IMMDC;
     }
-
 }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.