You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@clerezza.apache.org by ha...@apache.org on 2022/05/19 16:05:56 UTC
[clerezza] branch master updated: CLEREZZA-1063: Fix code documentation
This is an automated email from the ASF dual-hosted git repository.
hasan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/clerezza.git
The following commit(s) were added to refs/heads/master by this push:
new c19db415 CLEREZZA-1063: Fix code documentation
c19db415 is described below
commit c19db4153a7858ef25ad86d4a3c313da3594fa13
Author: Hasan <ha...@apache.org>
AuthorDate: Thu May 19 18:05:28 2022 +0200
CLEREZZA-1063: Fix code documentation
---
api/src/main/java/org/apache/clerezza/ImmutableGraph.java | 5 ++---
api/src/main/java/org/apache/clerezza/Language.java | 2 +-
api/src/main/java/org/apache/clerezza/Literal.java | 5 ++---
api/src/main/java/org/apache/clerezza/Triple.java | 2 +-
api/src/main/java/org/apache/clerezza/WatchableGraph.java | 8 ++++----
5 files changed, 10 insertions(+), 12 deletions(-)
diff --git a/api/src/main/java/org/apache/clerezza/ImmutableGraph.java b/api/src/main/java/org/apache/clerezza/ImmutableGraph.java
index 6a18d2e2..171a18b9 100644
--- a/api/src/main/java/org/apache/clerezza/ImmutableGraph.java
+++ b/api/src/main/java/org/apache/clerezza/ImmutableGraph.java
@@ -27,7 +27,6 @@ package org.apache.clerezza;
* add/remove-methods are called.
*
* @author reto
- * @see org.apache.clerezza.rdf.core.impl.AbstractGraph
*/
public interface ImmutableGraph extends Graph {
@@ -42,8 +41,8 @@ public interface ImmutableGraph extends Graph {
/**
* Return the sum of the blank-nodes independent hashes of the triples.
* More precisely the hash of the triple is calculated as follows:
- * (hash(subject) >> 1) ^ hash(hashCode) ^ (hash(hashCode) << 1)
- * Where the hash-fucntion return the hashCode of the argument
+ * {@literal (hash(subject) >> 1) ^ hash(hashCode) ^ (hash(hashCode) << 1)}
+ * Where the hash-function return the hashCode of the argument
* for grounded arguments and 0 otherwise.
*
* @return hash code
diff --git a/api/src/main/java/org/apache/clerezza/Language.java b/api/src/main/java/org/apache/clerezza/Language.java
index 1273d519..261d5c34 100644
--- a/api/src/main/java/org/apache/clerezza/Language.java
+++ b/api/src/main/java/org/apache/clerezza/Language.java
@@ -29,7 +29,7 @@ public class Language {
/**
* Constructs the language tag defined by RDF 4646, normalized to lowercase.
*
- * @param the id as defined by RDF 4646, normalized to lowercase.
+ * @param id as defined by RDF 4646, normalized to lowercase.
*/
public Language(String id) {
if ((id == null) || (id.equals(""))) {
diff --git a/api/src/main/java/org/apache/clerezza/Literal.java b/api/src/main/java/org/apache/clerezza/Literal.java
index abb903a3..a410f594 100644
--- a/api/src/main/java/org/apache/clerezza/Literal.java
+++ b/api/src/main/java/org/apache/clerezza/Literal.java
@@ -20,9 +20,8 @@ package org.apache.clerezza;
/**
* Represents a literal value that can be a node in an RDF Graph.
* Literals are used to identify values such as numbers and dates by
- * means of a lexical representation. There are two types of literals
- * represented by the subinterfaces {@link PlainLiteral}
- * and {@link TypedLiteral}
+ * means of a lexical representation. There are two types of literals:
+ * PlainLiteral and TypedLiteral.
*
* @author reto
*/
diff --git a/api/src/main/java/org/apache/clerezza/Triple.java b/api/src/main/java/org/apache/clerezza/Triple.java
index 961fa7c0..166a2b7d 100644
--- a/api/src/main/java/org/apache/clerezza/Triple.java
+++ b/api/src/main/java/org/apache/clerezza/Triple.java
@@ -40,7 +40,7 @@ public interface Triple {
/**
* The hash code is computed as follow
- * (subject.hashCode() >> 1) ^ predicate.hashCode() ^ object.hashCode() << 1)
+ * {@literal (subject.hashCode() >> 1) ^ predicate.hashCode() ^ object.hashCode() << 1)}
* <p>
* Note that the hash returned is computed including the hash of BNodes, so
* it is not blank-node blind as in Graph.
diff --git a/api/src/main/java/org/apache/clerezza/WatchableGraph.java b/api/src/main/java/org/apache/clerezza/WatchableGraph.java
index 976f080d..667eeed9 100644
--- a/api/src/main/java/org/apache/clerezza/WatchableGraph.java
+++ b/api/src/main/java/org/apache/clerezza/WatchableGraph.java
@@ -54,12 +54,12 @@ public interface WatchableGraph extends Graph {
* listener can be garbage collected if its no longer referenced by another
* object.
* <p>
- * If delay is 0 notification will happen synchroneously.
+ * If delay is 0 notification will happen synchronously.
*
* @param listener The listener that will be notified
* @param filter The triple filter with which triples are tested,
* that were part of the modification.
- * @param delay The time period afer which the listener will be notified in milliseconds.
+ * @param delay The time period after which the listener will be notified in milliseconds.
*/
public void addGraphListener(GraphListener listener, FilterTriple filter,
long delay);
@@ -67,10 +67,10 @@ public interface WatchableGraph extends Graph {
/**
* Adds the specified <code>GraphListener</code> to the graph. This listener
* will be notified, when the graph is modified and the <code>Triple</code>
- * that was part of the modifiaction matched the specified
+ * that was part of the modification matched the specified
* <code>FilterTriple</code>. The notification will be passed without delay.
* <p>
- * Same as <code>addGraphListener(listener, filter, 0).
+ * Same as <code>addGraphListener(listener, filter, 0)</code>.
*
* @param listener The listener that will be notified
* @param filter The triple filter with which triples are tested,