You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2021/02/02 23:30:34 UTC
[incubator-nlpcraft] branch NLPCRAFT-206 updated: Fix javadoc.
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch NLPCRAFT-206
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/NLPCRAFT-206 by this push:
new fc3dec4 Fix javadoc.
fc3dec4 is described below
commit fc3dec4ba896b297b107bcfb1a24469adfe8d3f9
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Tue Feb 2 15:30:21 2021 -0800
Fix javadoc.
---
.../src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java | 2 +-
nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java | 4 ++--
.../src/main/scala/org/apache/nlpcraft/model/NCModelView.java | 4 ++--
.../org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java | 8 ++++----
.../scala/org/apache/nlpcraft/server/mdo/impl/NCMdoField.java | 2 +-
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java
index f096ce0..28d0aec 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCCustomParser.java
@@ -24,7 +24,7 @@ import java.util.*;
* Named Entity Recognizer (NER) implementation in cases when the standard declarative methods are not expressive
* enough. Instance of the parser should be made available in the model via {@link NCModel#getParsers()} method.
* <p>
- * By default the data model detects its elements by their declarative synonyms. However,
+ * By default, the data model detects its elements by their declarative synonyms. However,
* in some cases this is not expressive enough. In such cases, one or more user-defined parsers can be defined
* for the model that would allow the user to define its own NER logic to detect the model elements in the user
* input programmatically. Note that there can be multiple custom parsers per model and each one can detect
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
index 3da7f5a..b0b6cc4 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
@@ -77,7 +77,7 @@ public interface NCElement extends NCMetadata, Serializable {
/**
* Gets the list of groups this elements belongs to.
* <p>
- * Model element can belong to one or more groups. By default the element belongs to a single group whose group
+ * Model element can belong to one or more groups. By default, the element belongs to a single group whose group
* ID is equal to its {@link #getId() ID}. The proper grouping of the model elements is required for operation
* of Short-Term-Memory (STM) in {@link NCConversation conversation} (if and when conversation
* is used). Specifically, a token (i.e. found model element) that is part of the group set will override
@@ -103,7 +103,7 @@ public interface NCElement extends NCMetadata, Serializable {
* ]
* </pre>
*
- * @return List of groups this element belongs to. By default - the model element belongs to one group
+ * @return List of groups this element belongs to. By default, the model element belongs to one group
* with ID equal to the element {@link #getId() ID}.
* @see NCConversation
* @see #getId()
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
index f734ee9..4a6af92 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
@@ -675,7 +675,7 @@ public interface NCModelView extends NCMetadata {
/**
* Gets optional user defined model metadata that can be set by the developer and accessed later.
- * By default returns an empty map. Note that this metadata is different from the one returned
+ * By default, it returns an empty map. Note that this metadata is different from the one returned
* by {@link NCToken#getMetadata()} method. Note also that this metadata is mutable and can be
* changed at runtime by the model's code.
* <p>
@@ -812,7 +812,7 @@ public interface NCModelView extends NCMetadata {
* Gets optional user-defined model element parsers for custom NER implementations. Note that order of the parsers
* is important as they will be invoked in the same order they are returned.
* <p>
- * By default the data model detects its elements by their synonyms, regexp or DSL expressions. However,
+ * By default, the data model detects its elements by their synonyms, regexp or DSL expressions. However,
* in some cases these methods are not expressive enough. In such cases, a user-defined parser can be defined
* for the model that would allow the user to define its own NER logic to detect the model elements in the user
* input programmatically. Note that a single parser can detect any number of model elements.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java
index 896a1cb..df39787 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/test/NCTestClientBuilder.java
@@ -97,7 +97,7 @@ public class NCTestClientBuilder {
/**
* Sets non-default {@link CloseableHttpClient} custom supplier.
- * By default {@link CloseableHttpClient} created with {@link HttpClients#createDefault()}.
+ * By default, {@link CloseableHttpClient} created with {@link HttpClients#createDefault()}.
*
* @param cliSup {@link CloseableHttpClient} custom supplier.
* @return Builder instance for chaining calls.
@@ -110,7 +110,7 @@ public class NCTestClientBuilder {
/**
* Sets non-default API base URL. Only change it if your server is not running on localhost.
- * By default {@link NCTestClientBuilder#DFLT_BASEURL} is used.
+ * By default, {@link NCTestClientBuilder#DFLT_BASEURL} is used.
*
* @param baseUrl API base URL.
* @return Builder instance for chaining calls.
@@ -127,7 +127,7 @@ public class NCTestClientBuilder {
/**
* Sets non-default user credentials.
- * By default {@link NCTestClientBuilder#DFLT_EMAIL} and {@link NCTestClientBuilder#DFLT_PASSWORD} are used
+ * By default, {@link NCTestClientBuilder#DFLT_EMAIL} and {@link NCTestClientBuilder#DFLT_PASSWORD} are used
* and they match the default NLPCraft server user.
*
* @param email User email.
@@ -144,7 +144,7 @@ public class NCTestClientBuilder {
/**
* Sets the embedded probe mode flag. Default value is {@link #DFLT_EMBEDDED}. If set to {@code true} the test client
* will expect the {@link NCEmbeddedProbe embedded probe} running in the same JVM
- * and will use local callbacks for quicker results instead of a full REST roundtrip.
+ * and will use local callbacks for quicker results instead of a full REST round trip.
*
* @param embedded Embedded probe mode flag.
* @return Builder instance for chaining calls.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/server/mdo/impl/NCMdoField.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/server/mdo/impl/NCMdoField.java
index 43b1bfe..bdb6c0c 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/server/mdo/impl/NCMdoField.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/server/mdo/impl/NCMdoField.java
@@ -44,7 +44,7 @@ public @interface NCMdoField {
/**
* Optional function name to generate JSON value for the field.
*
- * By default the actual field value will be used for JSON export.
+ * By default, the actual field value will be used for JSON export.
* This converter function can be used to modify this default behavior.
*
* Converter function can have zero or one parameter only. If it has one parameter