You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ni...@apache.org on 2007/05/22 03:51:38 UTC

svn commit: r540390 - in /jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath: ./ ri/ ri/axes/ xml/

Author: niallp
Date: Mon May 21 18:51:37 2007
New Revision: 540390

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

Modified:
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ClassFunctions.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/JXPathContext.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/XMLDocumentContainer.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/Compiler.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/NamespaceResolver.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AncestorContext.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AttributeContext.java
    jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/xml/DocumentContainer.java

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ClassFunctions.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ClassFunctions.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ClassFunctions.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ClassFunctions.java Mon May 21 18:51:37 2007
@@ -64,7 +64,7 @@
     /**
      * Returns a set of one namespace - the one specified in the constructor.
      *
-     * @returns a singleton
+     * @return a singleton
      */
     public Set getUsedNamespaces() {
         return Collections.singleton(namespace);

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/JXPathContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/JXPathContext.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/JXPathContext.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/JXPathContext.java Mon May 21 18:51:37 2007
@@ -830,7 +830,7 @@
      * NamespaceContextPointer is the same as the Context Pointer, see
      * {@link #getContextPointer() getContextPointer()}
      * 
-     * @param contextPointer The pointer to the context where prefixes used in
+     * @param namespaceContextPointer The pointer to the context where prefixes used in
      *        XPath expressions should be resolved.
      */
     public void setNamespaceContextPointer(Pointer namespaceContextPointer) {

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/XMLDocumentContainer.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/XMLDocumentContainer.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/XMLDocumentContainer.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/XMLDocumentContainer.java Mon May 21 18:51:37 2007
@@ -49,7 +49,7 @@
     private Source source;
 
     /**
-     * @param  URL is a URL for an XML file. Use getClass().getResource
+     * @param xmlURL is a URL for an XML file. Use getClass().getResource
      * (resourceName) to load XML from a resource file.
      */
     public XMLDocumentContainer(URL xmlURL) {

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/Compiler.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/Compiler.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/Compiler.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/Compiler.java Mon May 21 18:51:37 2007
@@ -220,7 +220,7 @@
      *
      * @param qname is a QNAME object
      */
-    Object variableReference(Object qName);
+    Object variableReference(Object qname);
 
     /**
      * Produces an EXPRESSION object representing the computation of
@@ -273,7 +273,7 @@
     /**
      * Produces a NODE_TEST object that represents a node type test.
      *
-     * @param qname is a QNAME object
+     * @param nodeType is a NODE_TEST object
      */
     Object nodeTypeTest(int nodeType);
 
@@ -281,7 +281,7 @@
      * Produces  a NODE_TEST object that represents a processing instruction
      * test.
      *
-     * @param qname is a QNAME object
+     * @param instruction is a NODE_TEST object
      */
     Object processingInstructionTest(String instruction);
 

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/NamespaceResolver.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/NamespaceResolver.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/NamespaceResolver.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/NamespaceResolver.java Mon May 21 18:51:37 2007
@@ -72,7 +72,7 @@
      * prefix was not defined explicitly using the registerNamespace method,
      * JXPathContext will then check the context node to see if the prefix is
      * defined there. See
-     * {@link #setNamespaceContextPointer(Pointer) setNamespaceContextPointer}.
+     * {@link #setNamespaceContextPointer(NodePointer) setNamespaceContextPointer}.
      * 
      * @param prefix The namespace prefix to look up
      * @return namespace URI or null if the prefix is undefined.

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AncestorContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AncestorContext.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AncestorContext.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AncestorContext.java Mon May 21 18:51:37 2007
@@ -36,7 +36,7 @@
      * @param parentContext represents the previous step on the path
      * @param  includeSelf differentiates between "ancestor::" and "ancestor-
      * or-self::" axes
-     * @param nameTest is the name of the element(s) we are looking for
+     * @param nodeTest is the name of the element(s) we are looking for
      */
     public AncestorContext(
         EvalContext parentContext,

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AttributeContext.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AttributeContext.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AttributeContext.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/AttributeContext.java Mon May 21 18:51:37 2007
@@ -37,7 +37,7 @@
 
     /**
      * @param parentContext represents the previous step on the path
-     * @param nameTest is the name of the attribute we are looking for
+     * @param nodeTest is the name of the attribute we are looking for
      */
     public AttributeContext(EvalContext parentContext, NodeTest nodeTest) {
         super(parentContext);

Modified: jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/xml/DocumentContainer.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/xml/DocumentContainer.java?view=diff&rev=540390&r1=540389&r2=540390
==============================================================================
--- jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/xml/DocumentContainer.java (original)
+++ jakarta/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/xml/DocumentContainer.java Mon May 21 18:51:37 2007
@@ -74,7 +74,7 @@
     /**
      * Use this constructor if the desired model is DOM.
      *
-     * @param URL is a URL for an XML file.
+     * @param xmlURL is a URL for an XML file.
      * Use getClass().getResource(resourceName) to load XML from a
      * resource file.
      */
@@ -83,7 +83,7 @@
     }
 
     /**
-     * @param  URL is a URL for an XML file. Use getClass().getResource
+     * @param xmlURL is a URL for an XML file. Use getClass().getResource
      * (resourceName) to load XML from a resource file.
      *
      * @param model is one of the MODEL_* constants defined in this class. It



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org