svn commit: r570740 - /maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/tree/DependencyNode.java

[ca...@apache.org]

Author: carlos
Date: Wed Aug 29 03:31:20 2007
New Revision: 570740

URL: http://svn.apache.org/viewvc?rev=570740&view=rev
Log:
Add comment by Mark Hobson for getDepth deprecation

Modified:
    maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/tree/DependencyNode.java

Modified: maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/tree/DependencyNode.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/tree/DependencyNode.java?rev=570740&r1=570739&r2=570740&view=diff
==============================================================================
--- maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/tree/DependencyNode.java (original)
+++ maven/shared/trunk/maven-dependency-tree/src/main/java/org/apache/maven/shared/dependency/tree/DependencyNode.java Wed Aug 29 03:31:20 2007
@@ -360,9 +360,13 @@
     
     /**
      * Gets the depth of this dependency node within its hierarchy.
-     *
+     * 
      * @return the depth
-     * @deprecated As of 1.1, depth is computed by node hierarchy
+     * @deprecated As of 1.1, depth is computed by node hierarchy. With the introduction of node
+     *             visitors and filters since it can give misleading results. For example, consider
+     *             serialising a tree with a filter using a visitor: getDepth would return the
+     *             unfiltered depth of a node, whereas the correct depth would be calculated by the
+     *             visitor.
      */
     public int getDepth()
     {