You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by an...@apache.org on 2018/05/10 15:19:55 UTC
[4/8] jena git commit: JENA-1546: Javadoc fixes (jena-arq)
JENA-1546: Javadoc fixes (jena-arq)
Project: http://git-wip-us.apache.org/repos/asf/jena/repo
Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/d8667f6f
Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/d8667f6f
Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/d8667f6f
Branch: refs/heads/master
Commit: d8667f6f3b08ba9c6c819d9486e5d7cd89d556ba
Parents: f754a31
Author: Andy Seaborne <an...@apache.org>
Authored: Thu May 10 14:25:58 2018 +0100
Committer: Andy Seaborne <an...@apache.org>
Committed: Thu May 10 14:25:58 2018 +0100
----------------------------------------------------------------------
.../algebra/optimize/TransformFilterConjunction.java | 2 +-
.../sparql/algebra/optimize/TransformMergeBGPs.java | 4 ++--
.../algebra/optimize/TransformPathFlattern.java | 2 +-
.../org/apache/jena/sparql/core/Transactional.java | 4 ++--
.../org/apache/jena/sparql/engine/http/Service.java | 6 ++----
.../jena/sparql/function/library/FN_DateTime.java | 2 +-
.../jena/sparql/function/library/FN_StrLength.java | 2 +-
.../jena/sparql/function/library/FN_StrSubstring.java | 2 +-
.../org/apache/jena/sparql/function/library/date.java | 2 +-
.../apache/jena/sparql/sse/lang/ParseHandlerForm.java | 14 ++------------
.../jena/sparql/sse/lang/ParseHandlerResolver.java | 9 +++++----
.../src/main/java/org/apache/jena/web/HttpSC.java | 2 +-
12 files changed, 20 insertions(+), 31 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformFilterConjunction.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformFilterConjunction.java b/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformFilterConjunction.java
index b5557c8..3e73585 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformFilterConjunction.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformFilterConjunction.java
@@ -32,7 +32,7 @@ import org.apache.jena.sparql.expr.ExprList ;
* hence the statics for the real work.
*/
-/** Redo FILTER (A&&B) as FILTER(A) FILTER(B) (as an expr list).
+/** Redo {@literal FILTER (A&&B)} as FILTER(A) FILTER(B) (as an expr list).
* via multiple elements of the exprList of the OpFilter.
* This allows them to be placed independently.
*/
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformMergeBGPs.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformMergeBGPs.java b/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformMergeBGPs.java
index 312f2c3..289bfba 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformMergeBGPs.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformMergeBGPs.java
@@ -29,8 +29,8 @@ import org.apache.jena.sparql.core.BasicPattern ;
/** Merge BGPs
*
- * <li>(join BGP1 BGP2) => BGP
- * <li>(sequence ...BGP1 BGP2 ...) => (sequence ...BGP ...)
+ * <li>(join BGP1 BGP2) {@literal =>} BGP
+ * <li>(sequence ...BGP1 BGP2 ...) {@literal =>} (sequence ...BGP ...)
*/
public class TransformMergeBGPs extends TransformCopy {
@Override
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformPathFlattern.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformPathFlattern.java b/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformPathFlattern.java
index db768bd..6915233 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformPathFlattern.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/algebra/optimize/TransformPathFlattern.java
@@ -31,7 +31,7 @@ import org.apache.jena.sparql.path.PathLib ;
* exact transformation as per spec as there are better ways to do it for ARQ.
* For example,
* <ul>
- * <li>Path seq -> BGPs or a (sequence)
+ * <li>Path seq {@literal ->} BGPs or a (sequence)
* <li>"|" is not expanded into a union.
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/core/Transactional.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/core/Transactional.java b/jena-arq/src/main/java/org/apache/jena/sparql/core/Transactional.java
index 899f503..d87460a 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/core/Transactional.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/core/Transactional.java
@@ -32,8 +32,8 @@ import org.apache.jena.system.Txn;
* <p>{@code end()} is optional but preferred.
* <p>
* Helper code is available {@link Txn} so, for example:
- * <pre>Txn.executeRead(dataset, ()-> { ... sparql query ... });</pre>
- * <pre>Txn.executeWrite(dataset, ()-> { ... sparql update ... });</pre>
+ * <pre>Txn.executeRead(dataset, {@literal ()->} { ... sparql query ... });</pre>
+ * <pre>Txn.executeWrite(dataset, {@literal ()->} { ... sparql update ... });</pre>
* or use one of <tt>Txn.calculateRead</tt> and <tt>Txn.executeWrite</tt>
* to return a value for the transaction block.
* <p>
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/engine/http/Service.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/engine/http/Service.java b/jena-arq/src/main/java/org/apache/jena/sparql/engine/http/Service.java
index ae3f153..6dc9f38 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/engine/http/Service.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/engine/http/Service.java
@@ -61,12 +61,10 @@ public class Service {
/**
* Use this Symbol to allow passing additional service context variables
- * SERVICE <IRI> call. Parameters need to be grouped by SERVICE <IRI>, a
- * Map<String, Context> is assumed. The key of the first map is the SERVICE
+ * {@literal SERVICE <IRI>} call. Parameters need to be grouped by {@literal SERVICE <IRI>}, a
+ * {@literal Map<String, Context>} is assumed. The key of the first map is the SERVICE
* IRI, the value is a Context who's values will override any defaults in
* the original context.
- *
- * @see org.apache.jena.sparql.engine.http.Service
*/
public static final Symbol serviceContext = SystemARQ.allocSymbol(base, "serviceContext");
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_DateTime.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_DateTime.java b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_DateTime.java
index f13f149..91e7b92 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_DateTime.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_DateTime.java
@@ -22,7 +22,7 @@ import org.apache.jena.sparql.expr.NodeValue;
import org.apache.jena.sparql.expr.nodevalue.XSDFuncOp;
import org.apache.jena.sparql.function.FunctionBase2;
-/** fn:dateTime(xsd:date, xsd:time) -> xsd:dateTime */
+/** fn:dateTime(xsd:date, xsd:time) {@literal ->} xsd:dateTime */
public class FN_DateTime extends FunctionBase2 {
@Override
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrLength.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrLength.java b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrLength.java
index 29a4e75fe..080269c 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrLength.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrLength.java
@@ -22,7 +22,7 @@ import org.apache.jena.sparql.expr.NodeValue ;
import org.apache.jena.sparql.expr.nodevalue.XSDFuncOp ;
import org.apache.jena.sparql.function.FunctionBase1 ;
-/** string length - F&O operation */
+/** string length - {@literal F&O} operation */
public class FN_StrLength extends FunctionBase1
{
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrSubstring.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrSubstring.java b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrSubstring.java
index ba21190..e965d13 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrSubstring.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/FN_StrSubstring.java
@@ -28,7 +28,7 @@ import org.apache.jena.sparql.expr.NodeValue ;
import org.apache.jena.sparql.expr.nodevalue.XSDFuncOp ;
import org.apache.jena.sparql.function.FunctionBase ;
-/** substring(string, start[, length]) - F&O style*/
+/** substring(string, start[, length]) - {@literal F&O} style*/
public class FN_StrSubstring extends FunctionBase
{
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/function/library/date.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/date.java b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/date.java
index d967e6c..34df515 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/function/library/date.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/function/library/date.java
@@ -24,7 +24,7 @@ import org.apache.jena.sparql.expr.ExprEvalException ;
import org.apache.jena.sparql.expr.NodeValue ;
import org.apache.jena.sparql.function.FunctionBase1 ;
-/** date(expression) => XSD dateTime
+/** date(expression) {@literal =>} XSD dateTime
* Attempt to convert an expression to an XSD dateTime.
* Supported conversions: Date as yyyy-mm-dd
*/
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerForm.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerForm.java b/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerForm.java
index af6f590..ea1039e 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerForm.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerForm.java
@@ -24,19 +24,9 @@ import java.util.Deque ;
import org.apache.jena.sparql.sse.Item ;
import org.apache.jena.sparql.sse.ItemList ;
-/** Resolve syntactic forms like (base ...) and (prefix...)
+/** Habdle forms like (base ...) and (prefix...)
* where the syntax modifies the enclosed sub term.
- *
- *
- * Forms:
- * (FORM DECL... TERM) => where TERM is the result.
- * Examples
- * (prefix (PREFIXES) TERM) => TERM with prefix names expanded
- * (base IRI TERM) => TERM with IRIs resolved to absolute IRIs
- *
- * The DECL part can not itself have nested, independent forms
- * unless a subclass (carefully) manages that. */
-
+ */
public abstract class ParseHandlerForm extends ParseHandlerPlain
{
// generally: (FORM DECL* TERM?)
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerResolver.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerResolver.java b/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerResolver.java
index 5250a0e..08446c2 100644
--- a/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerResolver.java
+++ b/jena-arq/src/main/java/org/apache/jena/sparql/sse/lang/ParseHandlerResolver.java
@@ -34,13 +34,14 @@ import org.apache.jena.sparql.sse.builders.BuilderPrefixMapping ;
*
*
* Forms:
- * (FORM DECL... TERM) => where TERM is the result.
+ * (FORM DECL... TERM) {@literal =>} where TERM is the result.
* Examples
- * (prefix (PREFIXES) TERM) => TERM with prefix names expanded
- * (base IRI TERM) => TERM with IRIs resolved to absolute IRIs
+ * (prefix (PREFIXES) TERM) {@literal =>} TERM with prefix names expanded
+ * (base IRI TERM) {@literal =>} TERM with IRIs resolved to absolute IRIs
*
* The DECL part can not itself have nested, independent forms
- * unless a subclass (carefully) manages that. */
+ * unless a subclass (carefully) manages that.
+ */
public class ParseHandlerResolver extends ParseHandlerForm
{
http://git-wip-us.apache.org/repos/asf/jena/blob/d8667f6f/jena-arq/src/main/java/org/apache/jena/web/HttpSC.java
----------------------------------------------------------------------
diff --git a/jena-arq/src/main/java/org/apache/jena/web/HttpSC.java b/jena-arq/src/main/java/org/apache/jena/web/HttpSC.java
index dfa1a95..025c7bc 100644
--- a/jena-arq/src/main/java/org/apache/jena/web/HttpSC.java
+++ b/jena-arq/src/main/java/org/apache/jena/web/HttpSC.java
@@ -467,7 +467,7 @@ package org.apache.jena.web;
* <td> </td>
* <td><strike>418</strike></td>
* <td><strike>Unprocessable Entity</strike></td>
- * <td> <direct/td>
+ * <td> </td>
* <td> </td>
* <td>
* <a href=