From dd03e4ea35eae265b1101c6a0b23df2bf72e1314 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=93scar=20Gonz=C3=A1lez=20Fern=C3=A1ndez?=
 <ogonzalez@igalia.com>
Date: Thu, 16 Sep 2010 12:42:25 +0200
Subject: [PATCH] Document class so it's easier to understand purpose

FEA: ItEr60S19TimeUnitDataType
---
 .../planner/entities/ResourceAllocation.java       | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/ResourceAllocation.java b/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/ResourceAllocation.java
index 1168c0788..84d1cae6a 100644
--- a/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/ResourceAllocation.java
+++ b/navalplanner-business/src/main/java/org/navalplanner/business/planner/entities/ResourceAllocation.java
@@ -286,6 +286,20 @@ public abstract class ResourceAllocation<T extends DayAssignment> extends
         return new HoursAllocationSpecified(hoursModifications);
     }
 
+    /**
+     * Needed for doing fluent interface calls:
+     * <ul>
+     * <li>
+     * {@link ResourceAllocation#allocatingHours(List)}.
+     * {@link HoursAllocationSpecified#allocateUntil(LocalDate)
+     * allocateUntil(LocalDate)}</li>
+     * <li>
+     * {@link ResourceAllocation#allocatingHours(List)}.
+     * {@link HoursAllocationSpecified#allocate() allocate()}</li>
+     * </li>
+     * </ul>
+     *
+     */
     public static class HoursAllocationSpecified {
 
         private final List<HoursModification> hoursModifications;