491339 messages in 933 lists

Commit in jaxen/src/java/main/org/jaxen/dom on MAIN
DocumentNavigator.java +11 -10 1.56 -> 1.57
Minor JavaDoc improvements

jaxen/src/java/main/org/jaxen/dom
DocumentNavigator.java 1.56 -> 1.57
diff -u -r1.56 -r1.57
--- DocumentNavigator.java      3 Jul 2006 13:08:43 -0000      
1.56
+++ DocumentNavigator.java      5 May 2007 18:08:55 -0000      
1.57
@@ -1,9 +1,9 @@

 package org.jaxen.dom;
 
 /*
- * $Header:
/home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/dom/DocumentNavigator.java,v
1.56 2006/07/03 13:08:43 elharo Exp $
- * $Revision: 1.56 $
- * $Date: 2006/07/03 13:08:43 $
+ * $Header:
/home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/dom/DocumentNavigator.java,v
1.57 2007/05/05 18:08:55 elharo Exp $
+ * $Revision: 1.57 $
+ * $Date: 2007/05/05 18:08:55 $
  *
  *
====================================================================
  *
@@ -45,7 +45,7 @@

  * James Strachan <jstrachan@apache...>.  For more
information on the
  * Jaxen Project, please see <http://www.jaxen.org/>.
  *
- * $Id: DocumentNavigator.java,v 1.5
6 2006/07/03 13:08:43 elharo Exp $
+ * $Id: DocumentNavigator.java,v 1.5
7 2007/05/05 18:08:55 elharo Exp $
 */
 
 import javax.xml.parsers.DocumentBuilder;
@@ -199,17 +199,17 @@

     
     
     /** 
-     * Return the XPath parent of th
is DOM node.
+     * Return the XPath parent of th
e supplied DOM node.
      * XPath has slightly different definition of parent than DOM
does.
      * In particular, the parent of an attribute is not null.
      * 
-     * @param o 
+     * @param child the child node
      * 
      * @return the parent of the specified node; or null if
      *     the node does not have a parent
      */
-    public Object getParentNode(Object o) {
-        Node node = (Node) o;
+    public Object getParentNode(Object child) {
+        Node node = (Node) child;
         if (node.getNodeType() == Node.ATTRIBUTE_NODE) {
             return ((Attr) node).getOwnerElement();
         }
@@ -803,6 +803,8 @@

      * @return the new W3C DOM Level 2 Document instance
      * @throws FunctionCallException containing a nested exception
      *      if a problem occurs trying to parse the given document
+     *
+     * @todo Possibly we could make the factory a thread local.
      */
     public Object getDocument(String uri) throws
FunctionCallException
     {
@@ -810,7 +812,6 @@

         {
             // We really do need to construct a new factory here
each time.
             // DocumentBuilderFactory is not guaranteed to be
thread safe? 
-            // Possibly we could make this a thread local.????
             DocumentBuilderFactory factory =
DocumentBuilderFactory.newInstance();
             factory.setNamespaceAware(true);
             DocumentBuilder builder =
factory.newDocumentBuilder();
@@ -1049,7 +1050,7 @@

      *            does not know about attribute types
      *  @see   javax.xml.parsers.DocumentBuilderFactory
      *  
-     *  @throws ClassCastException if object is not an 
org.w3c.dom.Node object
+     *  @throws ClassCastException if object is not an 
<code>org.w3c.dom.Node</code>
object
      *  
      */
     public Object getElementById(Object object, String elementId)
CVSspam 0.2.12
Message Thread
[CVS jaxen] Minor JavaDoc improvements elharo@codehaus...
05 May 2007
Copyright 2006-2008 The Codehaus Foundation
Powered by Codehaus March (Version: 0.1-HEAD)