From 7e317b6dff0094738739be9d751cf4758e4c822e 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:24:45 +0200
Subject: [PATCH] Document class so it's easier to understand purpose

FEA: ItEr60S19TimeUnitDataType
---
 .../planner/entities/ResourceAllocation.java      | 15 +++++++++++++++
 1 file changed, 15 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 27d91f212..ad0470335 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
@@ -145,6 +145,21 @@ public abstract class ResourceAllocation<T extends DayAssignment> extends
         return new AllocationsCurried(resourceAllocations);
     }
 
+    /**
+     * Needed for doing fluent interface calls:
+     * <ul>
+     * <li>
+     * {@link ResourceAllocation#allocating(List)}.
+     * {@link AllocationsCurried#untilAllocating(int) untiAllocating(int)}</li>
+     * <li> {@link ResourceAllocation#allocating(List)}.
+     * {@link AllocationsCurried#allocateOnTaskLength() allocateOnTaskLength}</li>
+     * <li>
+     * {@link ResourceAllocation#allocating(List)}.
+     * {@link AllocationsCurried#allocateUntil(LocalDate)
+     * allocateUntil(LocalDate)}</li>
+     * </ul>
+     *
+     */
     public static class AllocationsCurried {
 
         private final List<ResourcesPerDayModification> allocations;