svn commit: r1097642 - /ant/ivy/core/trunk/src/java/org/apache/ivy/core/sort/SortEngine.java

[hi...@apache.org]

Author: hibou
Date: Thu Apr 28 22:19:32 2011
New Revision: 1097642

URL: http://svn.apache.org/viewvc?rev=1097642&view=rev
Log:
javadoc

Modified:
    ant/ivy/core/trunk/src/java/org/apache/ivy/core/sort/SortEngine.java

Modified: ant/ivy/core/trunk/src/java/org/apache/ivy/core/sort/SortEngine.java
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/src/java/org/apache/ivy/core/sort/SortEngine.java?rev=1097642&r1=1097641&r2=1097642&view=diff
==============================================================================
--- ant/ivy/core/trunk/src/java/org/apache/ivy/core/sort/SortEngine.java (original)
+++ ant/ivy/core/trunk/src/java/org/apache/ivy/core/sort/SortEngine.java Thu Apr 28 22:19:32 2011
@@ -43,9 +43,19 @@ public class SortEngine {
         this.settings = settings;
     }
 
-    
-
-    public List sortNodes(Collection nodes, SortOptions options) {
+    /**
+     * Same as {@link #sortModuleDescriptors(Collection, SortOptions)} but for <code>IvyNode</code>s.
+     * 
+     * @param nodes
+     *            a Collection of nodes to sort
+     * @param options
+     *            Options to use to sort the nodes.
+     * @return a List of sorted IvyNode
+     * @throws CircularDependencyException
+     *             if a circular dependency exists and circular dependency strategy decide to throw
+     *             an exception
+     */
+    public List/* <IvyNode> */sortNodes(Collection/* <IvyNode> */nodes, SortOptions options) {
         /*
          * here we want to use the sort algorithm which work on module descriptors : so we first put
          * dependencies on a map from descriptors to dependency, then we sort the keySet (i.e. a