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

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

Revision: 188
          http://svn.sourceforge.net/objectlabkit/?rev=188&view=rev
Author:   benoitx
Date:     2006-09-19 03:01:13 -0700 (Tue, 19 Sep 2006)

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

Modified Paths:
--------------
    trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/HolidayHandlerYearMonthDayWrapper.java
    trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateCalculator.java
    trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateKitCalculatorsFactory.java
    trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/YearMonthDayKitCalculatorsFactory.java

Modified: trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/HolidayHandlerYearMonthDayWrapper.java
===================================================================
--- trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/HolidayHandlerYearMonthDayWrapper.java	2006-09-19 09:58:18 UTC (rev 187)
+++ trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/HolidayHandlerYearMonthDayWrapper.java	2006-09-19 10:01:13 UTC (rev 188)
@@ -44,7 +44,6 @@
      * 
      * @param calculator
      *            the calculator
-     * @return the date which may have moved.
      */
     public HolidayHandlerYearMonthDayWrapper(final HolidayHandler<YearMonthDay> delegate,
             final DateCalculator<YearMonthDay> calculator) {

Modified: trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateCalculator.java
===================================================================
--- trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateCalculator.java	2006-09-19 09:58:18 UTC (rev 187)
+++ trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateCalculator.java	2006-09-19 10:01:13 UTC (rev 188)
@@ -53,12 +53,15 @@
     }
 
     /**
-     * @todo throw an exception if the WorkinWeek type is wrong
-     * 
+     * Set the working week.
+     * @param week the JodaWorkingWeek
+     * @throws IllegalArgumentException if the week is not a JodaWorkingWeek.
      */
     public void setWorkingWeek(final WorkingWeek week) {
         if (week instanceof JodaWorkingWeek) {
             workingWeek = (JodaWorkingWeek) week;
+        } else {
+            throw new IllegalArgumentException("Please give an instance of JodaWorkingWeek");
         }
     }
 

Modified: trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateKitCalculatorsFactory.java
===================================================================
--- trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateKitCalculatorsFactory.java	2006-09-19 09:58:18 UTC (rev 187)
+++ trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/LocalDateKitCalculatorsFactory.java	2006-09-19 10:01:13 UTC (rev 188)
@@ -52,7 +52,7 @@
      *            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 type
+     * @param holidayHandlerType
      *            typically one of the value of HolidayHandlerType
      * @return a new DateCalculator
      */

Modified: trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/YearMonthDayKitCalculatorsFactory.java
===================================================================
--- trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/YearMonthDayKitCalculatorsFactory.java	2006-09-19 09:58:18 UTC (rev 187)
+++ trunk/datecalc-joda/src/main/java/net/objectlab/kit/datecalc/joda/YearMonthDayKitCalculatorsFactory.java	2006-09-19 10:01:13 UTC (rev 188)
@@ -54,7 +54,7 @@
      *            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 type
+     * @param holidayHandlerType
      *            typically one of the value of HolidayHandlerType
      * @return a new DateCalculator
      */


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