This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/master by this push:
new 3ae2760d Javadoc.
3ae2760d is described below
commit 3ae2760d8ec85931261badb57672c822368f83e2
Author: Aaron Radzinski <[email protected]>
AuthorDate: Fri Apr 8 19:47:24 2022 -0700
Javadoc.
---
nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.java | 6 +++++-
.../src/main/scala/org/apache/nlpcraft/NCEntityEnricher.java | 1 +
.../src/main/scala/org/apache/nlpcraft/NCEntityMapper.java | 1 +
.../src/main/scala/org/apache/nlpcraft/NCEntityParser.java | 1 +
.../src/main/scala/org/apache/nlpcraft/NCEntityValidator.java | 1 +
nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java | 2 +-
nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.java | 6 +++++-
.../src/main/scala/org/apache/nlpcraft/NCTokenEnricher.java | 9 +++++++++
.../src/main/scala/org/apache/nlpcraft/NCTokenParser.java | 7 ++++++-
.../src/main/scala/org/apache/nlpcraft/NCTokenValidator.java | 11 ++++++++++-
10 files changed, 40 insertions(+), 5 deletions(-)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.java
index 44c7eb3f..ab0137e9 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.java
@@ -34,11 +34,15 @@ import java.util.stream.Collectors;
* that allows them to store custom metadata properties. Parser, enrichers and
validators for tokens
* and entities use this capability to store and check their properties in
tokens and entities.
*
+ * @see NCEntity
* @see NCToken
* @see NCTokenParser
* @see NCTokenEnricher
* @see NCTokenValidator
- * @see NCPipeline
+ * @see NCEntityParser
+ * @see NCEntityEnricher
+ * @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCEntity extends NCPropertyMap {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.java
index 902e0528..118948f0 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.java
@@ -33,6 +33,7 @@ import java.util.List;
* @see NCEntityParser
* @see NCEntityEnricher
* @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCEntityEnricher extends NCLifecycle {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.java
index f06fefe3..cbe8e226 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.java
@@ -34,6 +34,7 @@ import java.util.List;
* @see NCEntityParser
* @see NCEntityEnricher
* @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCEntityMapper extends NCLifecycle {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.java
index d45f97cf..f77cc52d 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.java
@@ -33,6 +33,7 @@ import java.util.List;
* @see NCEntityParser
* @see NCEntityEnricher
* @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCEntityParser extends NCLifecycle {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.java
index 14c54256..9e487761 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.java
@@ -33,6 +33,7 @@ import java.util.List;
* @see NCEntityParser
* @see NCEntityEnricher
* @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCEntityValidator extends NCLifecycle {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
index 79bce7fa..be45a2f2 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.java
@@ -109,7 +109,7 @@ public interface NCPipeline {
default Optional<NCVariantFilter> getVariantFilter() {
return Optional.empty();
}
-
+
/**
* Gets optional list of entity mappers.
*
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.java
index 8d2d1424..d1953d6a 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.java
@@ -28,10 +28,14 @@ package org.apache.nlpcraft;
* and entities use this capability to store and check their properties in
tokens and entities.
*
* @see NCEntity
+ * @see NCToken
* @see NCTokenParser
* @see NCTokenEnricher
* @see NCTokenValidator
- * @see NCPipeline
+ * @see NCEntityParser
+ * @see NCEntityEnricher
+ * @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCToken extends NCPropertyMap {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.java
index b849a24e..6d8571ca 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.java
@@ -21,6 +21,15 @@ import java.util.List;
/**
*
+ * @see NCEntity
+ * @see NCToken
+ * @see NCTokenParser
+ * @see NCTokenEnricher
+ * @see NCTokenValidator
+ * @see NCEntityParser
+ * @see NCEntityEnricher
+ * @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCTokenEnricher extends NCLifecycle {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.java
index 69d3ae1b..de33198d 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.java
@@ -25,10 +25,15 @@ import java.util.List;
* See {@link NCPipeline} for documentation on the token parser place
* in the overall processing pipeline.
*
+ * @see NCEntity
* @see NCToken
+ * @see NCTokenParser
* @see NCTokenEnricher
* @see NCTokenValidator
- * @see NCPipeline
+ * @see NCEntityParser
+ * @see NCEntityEnricher
+ * @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCTokenParser {
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.java
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.java
index 64616a33..94b7ffe9 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.java
@@ -20,7 +20,16 @@ package org.apache.nlpcraft;
import java.util.List;
/**
- *
+ *
+ * @see NCEntity
+ * @see NCToken
+ * @see NCTokenParser
+ * @see NCTokenEnricher
+ * @see NCTokenValidator
+ * @see NCEntityParser
+ * @see NCEntityEnricher
+ * @see NCEntityValidator
+ * @see NCEntityMapper
*/
public interface NCTokenValidator extends NCLifecycle {
/**
