[Openutils-svn] SF.net SVN: openutils:[2114] trunk/openutils-elfunctions/src/main/java/net/ sourceforge/openutils/elfunctions/CollectionElUtils.java

[<die...@us...>]

Revision: 2114
          http://openutils.svn.sourceforge.net/openutils/?rev=2114&view=rev
Author:   diego_schivo
Date:     2010-03-08 17:50:58 +0000 (Mon, 08 Mar 2010)

Log Message:
-----------
ELFUNCTIONS-6 javadoc

Modified Paths:
--------------
    trunk/openutils-elfunctions/src/main/java/net/sourceforge/openutils/elfunctions/CollectionElUtils.java

Modified: trunk/openutils-elfunctions/src/main/java/net/sourceforge/openutils/elfunctions/CollectionElUtils.java
===================================================================
--- trunk/openutils-elfunctions/src/main/java/net/sourceforge/openutils/elfunctions/CollectionElUtils.java	2010-03-08 17:50:29 UTC (rev 2113)
+++ trunk/openutils-elfunctions/src/main/java/net/sourceforge/openutils/elfunctions/CollectionElUtils.java	2010-03-08 17:50:58 UTC (rev 2114)
@@ -26,8 +26,8 @@
 
     /**
      * Converts an array to a list
-     * @param array
-     * @return
+     * @param array an object array
+     * @return a list representation of the array
      */
     public static List< ? > toList(Object[] array)
     {
@@ -40,8 +40,8 @@
 
     /**
      * Randomly permutes the specified list
-     * @param input
-     * @return
+     * @param input the list to be shuffled
+     * @return a shuffled list
      */
     public static List< ? > shuffle(List< ? > input)
     {
@@ -70,9 +70,9 @@
 
     /**
      * Splits a collection into pages of the specified size
-     * @param collection
-     * @param pageSize
-     * @return
+     * @param collection the collection to split into pages
+     * @param pageSize the maximum number of items per page
+     * @return a list of pages, where each page is a list too
      */
     public static List<List> paginateCollection(Collection collection, int pageSize)
     {


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