Fix documentation of ConstDeclNode.getConstNode().

jruby · Oct 22, 2014 · ea30db2 · ea30db2
1 parent 3f72e2c
commit ea30db2
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/core/src/main/java/org/jruby/ast/ConstDeclNode.java b/core/src/main/java/org/jruby/ast/ConstDeclNode.java
@@ -74,13 +74,16 @@ public String getName() {
     }
 
     /**
-     * Get the path the name is associated with or null (in Foo::BAR it is Foo).
+     * Get the full path, including the name of the new constant (in Foo::BAR it is Foo::BAR) or null.
+     * Your probably want to extract the left part with
+     * <code>((Colon2Node) node.getConstNode()).getLeftNode()</code>
+     * if <code>node.getConstNode()</code> is a <code>Colon2ConstNode</code>.
      * @return pathNode
      */
     public Node getConstNode() {
         return (Node) constNode;
     }
-    
+
     public List<Node> childNodes() {
         return createList(getConstNode(), getValueNode());
     }