This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jxpath.git
commit 242dc67a067936bf2105bf9dc98dfe5f491842f3
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Apr 13 15:45:24 2025 -0400
Add links to the User's Guide
---
src/main/java/org/apache/commons/jxpath/functions/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/ri/axes/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/ri/compiler/package-info.java | 4 +++-
.../java/org/apache/commons/jxpath/ri/model/beans/package-info.java | 4 +++-
.../org/apache/commons/jxpath/ri/model/container/package-info.java | 4 +++-
.../java/org/apache/commons/jxpath/ri/model/dom/package-info.java | 4 +++-
.../org/apache/commons/jxpath/ri/model/dynabeans/package-info.java | 4 +++-
.../java/org/apache/commons/jxpath/ri/model/dynamic/package-info.java | 4 +++-
.../java/org/apache/commons/jxpath/ri/model/jdom/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/ri/model/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/ri/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/ri/parser/package-info.java | 2 ++
src/main/java/org/apache/commons/jxpath/servlet/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/util/package-info.java | 4 +++-
src/main/java/org/apache/commons/jxpath/xml/package-info.java | 4 +++-
16 files changed, 47 insertions(+), 15 deletions(-)
diff --git
a/src/main/java/org/apache/commons/jxpath/functions/package-info.java
b/src/main/java/org/apache/commons/jxpath/functions/package-info.java
index 9ccf59a..c5fd0ee 100644
--- a/src/main/java/org/apache/commons/jxpath/functions/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/functions/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementations of Java class-based extension functions.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.functions;
diff --git a/src/main/java/org/apache/commons/jxpath/package-info.java
b/src/main/java/org/apache/commons/jxpath/package-info.java
index ca769ee..da93a8f 100644
--- a/src/main/java/org/apache/commons/jxpath/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/package-info.java
@@ -14,9 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Public, abstract part of JXPath: interfaces and configuration. If you are a
user of JXPath and don't plan to modify its implementation, this is the only
* package you'll need to use. Start with the {@link
org.apache.commons.jxpath.JXPathContext} class.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath;
diff --git a/src/main/java/org/apache/commons/jxpath/ri/axes/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/axes/package-info.java
index ee8fdb2..4de0ef7 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/axes/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/axes/package-info.java
@@ -14,9 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementations of EvalContext used for different XPath axes (child::,
parent:: etc). In order to evaluate a path, RI creates a chain of EvalContexts,
one
* for each step in the path.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>
*/
-
package org.apache.commons.jxpath.ri.axes;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/compiler/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/compiler/package-info.java
index 3bd67d7..b429374 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/compiler/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/compiler/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* XPath parse tree. TreeCompiler is the class responsible for the
construction of a parse tree out of individual elements.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.compiler;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/beans/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/beans/package-info.java
index 570b87b..f8d296d 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/beans/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/beans/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for JavaBeans, Dynamic Property Objects,
collections and null.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model.beans;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/container/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/container/package-info.java
index 3686ccf..433ca32 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/model/container/package-info.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/model/container/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for Containers.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model.container;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/dom/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/dom/package-info.java
index d9498d7..7e5b673 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/dom/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/dom/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for W3C DOM.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model.dom;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/dynabeans/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/dynabeans/package-info.java
index 89706ad..84b7740 100644
---
a/src/main/java/org/apache/commons/jxpath/ri/model/dynabeans/package-info.java
+++
b/src/main/java/org/apache/commons/jxpath/ri/model/dynabeans/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for Commons BeanUtils DynaBeans.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model.dynabeans;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/dynamic/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/dynamic/package-info.java
index 333f8cd..bda2378 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/dynamic/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/dynamic/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for dynamic property objects e.g. Maps or
anything else for which a client can provide a DynamicPropertyHandler class.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model.dynamic;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/model/jdom/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/jdom/package-info.java
index 92ec764..f1a95d9 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/jdom/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/jdom/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for JDOM (see jdom.org).
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model.jdom;
diff --git a/src/main/java/org/apache/commons/jxpath/ri/model/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/model/package-info.java
index 9b575ae..4f65643 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/model/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/model/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementation of "model" APIs for Containers.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri.model;
diff --git a/src/main/java/org/apache/commons/jxpath/ri/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/package-info.java
index 7516fb8..6b0102a 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/package-info.java
@@ -14,9 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Reference implementation of JXPath. It comes with a JavaCC-based parser for
XPath expressions, a parse tree and a fast interpreter, which applies XPaths to
* graphs of Java objects.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.ri;
diff --git
a/src/main/java/org/apache/commons/jxpath/ri/parser/package-info.java
b/src/main/java/org/apache/commons/jxpath/ri/parser/package-info.java
index 783dbac..19f5a07 100644
--- a/src/main/java/org/apache/commons/jxpath/ri/parser/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/ri/parser/package-info.java
@@ -17,5 +17,7 @@
/**
* JavaCC XPath grammar. All classes in this package were generated by JavaCC.
The grammar definition is in the XPath.jj file.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
package org.apache.commons.jxpath.ri.parser;
diff --git a/src/main/java/org/apache/commons/jxpath/servlet/package-info.java
b/src/main/java/org/apache/commons/jxpath/servlet/package-info.java
index 2a2ea1b..5d7758d 100644
--- a/src/main/java/org/apache/commons/jxpath/servlet/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/servlet/package-info.java
@@ -14,9 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Implementations of JXPathContexts bound to various servlet scopes:
PageContext, ServletRequest, HttpSession and ServletContext. Start with the
* {@link org.apache.commons.jxpath.servlet.JXPathServletContexts} class.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.servlet;
diff --git a/src/main/java/org/apache/commons/jxpath/util/package-info.java
b/src/main/java/org/apache/commons/jxpath/util/package-info.java
index 6304cc7..f53c0c4 100644
--- a/src/main/java/org/apache/commons/jxpath/util/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/util/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Utility classes to assist with JXPath implementation(s) and/or usage.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.util;
diff --git a/src/main/java/org/apache/commons/jxpath/xml/package-info.java
b/src/main/java/org/apache/commons/jxpath/xml/package-info.java
index d655139..efc66d0 100644
--- a/src/main/java/org/apache/commons/jxpath/xml/package-info.java
+++ b/src/main/java/org/apache/commons/jxpath/xml/package-info.java
@@ -14,8 +14,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
/**
* Support classes for working with XML.
+ *
+ * @see <a
href="https://commons.apache.org/proper/commons-jxpath/apidocs/index.html";>User's
Guide</a>.
*/
-
package org.apache.commons.jxpath.xml;
