Javadoc

Author: garydgregory

src/changes/changes.xml

@@ -100,6 +100,7 @@ The <action> type attribute can be add,update,fix,remove.
       <action dev="ggregory" type="fix" due-to="step-security-bot, Gary Gregory">
         [StepSecurity] CI: Harden GitHub Actions #66.
       </action>
+      <action dev="ggregory" type="fix" due-to="Gary Gregory">Add missing Javadoc.</action>
       <action dev="ggregory" type="fix" due-to="Gary Gregory">Fix PMD UnnecessaryFullyQualifiedName.</action>
       <action dev="ggregory" type="fix" due-to="Gary Gregory">Add generics to JXPathContext.iterate(String).</action>
       <action dev="ggregory" type="fix" due-to="Gary Gregory">Add generics to JXPathContext.iteratePointers(String).</action>

src/main/java/org/apache/commons/jxpath/FunctionLibrary.java

@@ -32,6 +32,13 @@ public class FunctionLibrary implements Functions {
     private final List<Functions> allFunctions = new ArrayList<>();
     private Map<String, Object> byNamespace;
 
+    /**
+     * Constructs a new instance.
+     */
+    public FunctionLibrary() {
+        // empty
+    }
+
     /**
      * Add functions to the library
      *

src/main/java/org/apache/commons/jxpath/ri/axes/NamespaceContext.java

@@ -35,6 +35,8 @@ public class NamespaceContext extends EvalContext {
     private NodePointer currentNodePointer;
 
     /**
+     * Constructs a new instance.
+     *
      * @param parentContext represents the previous step on the path
      * @param nodeTest      is the name of the namespace we are looking for
      */

src/main/java/org/apache/commons/jxpath/ri/axes/RootContext.java

@@ -30,7 +30,11 @@
  */
 public class RootContext extends EvalContext {
 
+    /**
+     * Unknown value marker.
+     */
     public static final Object UNKNOWN_VALUE = new Object();
+
     private static final int MAX_REGISTER = 4;
     private final JXPathContextReferenceImpl jxpathContext;
     private final NodePointer pointer;

src/main/java/org/apache/commons/jxpath/ri/compiler/Expression.java

@@ -124,6 +124,13 @@ public void remove() {
     private boolean contextDependencyKnown = false;
     private boolean contextDependent;
 
+    /**
+     * Constructs a new instance.
+     */
+    public Expression() {
+        // empty
+    }
+
     /**
      * Evaluates the expression. If the result is a node set, returns the first element of the node set.
      * 

src/main/java/org/apache/commons/jxpath/ri/compiler/NodeNameTest.java

@@ -20,6 +20,7 @@
 import org.apache.commons.jxpath.ri.QName;
 
 /**
+ * Node name test.
  */
 public class NodeNameTest extends NodeTest {
 

src/main/java/org/apache/commons/jxpath/ri/compiler/NodeTypeTest.java

@@ -20,6 +20,7 @@
 import org.apache.commons.jxpath.ri.Compiler;
 
 /**
+ * Node type test.
  */
 public class NodeTypeTest extends NodeTest {
 

src/main/java/org/apache/commons/jxpath/ri/compiler/ProcessingInstructionTest.java

@@ -18,6 +18,7 @@
 package org.apache.commons.jxpath.ri.compiler;
 
 /**
+ * Processing instruction test.
  */
 public class ProcessingInstructionTest extends NodeTest {
 

src/main/java/org/apache/commons/jxpath/ri/model/NodePointer.java

@@ -460,8 +460,10 @@ public NodePointer getImmediateParentPointer() {
     }
 
     /**
-     * @see #getValuePointer()
+     * Gets this instance by default, subclasses can return a pointer for the immediately contained value.
+     *
      * @return NodePointer is either {@code this} or a pointer for the immediately contained value.
+     * @see #getValuePointer()
      */
     public NodePointer getImmediateValuePointer() {
         return this;
@@ -471,7 +473,7 @@ public NodePointer getImmediateValuePointer() {
      * If the pointer represents a collection, the index identifies an element of that collection. The default value of {@code index} is
      * {@code WHOLE_COLLECTION}, which just means that the pointer is not indexed at all. Note: the index on NodePointer starts with 0, not 1.
      * 
-     * @return int
+     * @return the index.
      */
     public int getIndex() {
         return index;
@@ -480,7 +482,7 @@ public int getIndex() {
     /**
      * If the pointer represents a collection (or collection element), returns the length of the collection. Otherwise returns 1 (even if the value is null).
      * 
-     * @return int
+     * @return the length.
      */
     public abstract int getLength();
 
@@ -497,9 +499,9 @@ public Locale getLocale() {
     }
 
     /**
-     * Returns the name of this node. Can be null.
+     * Gets the name of this node. Can be null.
      * 
-     * @return QName
+     * @return QName The name of this node. Can be null.
      */
     public abstract QName getName();