svn commit: r656402 - /commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.java

Author: oheger
Date: Wed May 14 13:15:23 2008
New Revision: 656402

URL: http://svn.apache.org/viewvc?rev=656402&view=rev
Log:
Javadoc improvements

Modified:
    commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.java

Modified: commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.java?rev=656402&r1=656401&r2=656402&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.java (original)
+++ commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.java Wed May 14 13:15:23 2008
@@ -36,7 +36,7 @@
  * <p>
  * This class makes use of <a href="http://commons.apache.org/jxpath/">
  * Commons JXPath</a> for handling XPath expressions and mapping them to the
- * nodes of a hierarchical configuration. This makes the rich and powerfull
+ * nodes of a hierarchical configuration. This makes the rich and powerful
  * XPATH syntax available for accessing properties from a configuration object.
  * </p>
  * <p>
@@ -56,7 +56,7 @@
  * select exactly one node, otherwise an exception will be thrown.</li>
  * <li>The name of the new element(s) to be added below this parent node. Here
  * either a single node name or a complete path of nodes (separated by the
- * "/" character) can be specified.</li>
+ * "/" character or "@" for an attribute) can be specified.</li>
  * </ol>
  * Some examples for valid keys that can be passed into the configuration's
  * <code>addProperty()</code> method follow:
@@ -97,6 +97,21 @@
  * <code>name</code> will be added.
  * </p>
  *
+ * <p>
+ * <pre>
+ * "/tables table/fields/field@type"
+ * </pre>
+ * </p>
+ * <p>
+ * This is similar to the last example, but in this case a complex path ending
+ * with an attribute is defined.
+ * </p>
+ * <p>
+ * <strong>Note:</strong> This extended syntax for adding properties only works
+ * with the <code>addProperty()</code> method. <code>setProperty()</code> does
+ * not support creating new nodes this way.
+ * </p>
+ *
  * @since 1.3
  * @author Oliver Heger
  * @version $Id$
@@ -241,7 +256,7 @@
     /**
      * Initializes most properties of a <code>NodeAddData</code> object. This
      * method is called by <code>prepareAdd()</code> after the parent node has
-     * been found. Its task is to interprete the passed in path of the new node.
+     * been found. Its task is to interpret the passed in path of the new node.
      *
      * @param data the data object to initialize
      * @param path the path of the new node