[incubator-nlpcraft] 02/02: Javadoc fixes.

[ar...@apache.org]

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

commit 07b978601b0b173aebc1ff8faf6954a99ea3aa79
Author: unknown <ar...@datalingvo.com>
AuthorDate: Wed May 12 12:01:13 2021 -0700

    Javadoc fixes.
---
 nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java   | 2 +-
 nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java | 6 +++---
 nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java    | 4 ++--
 3 files changed, 6 insertions(+), 6 deletions(-)

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 c0d9ec6..7ec79b2 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCElement.java
@@ -358,7 +358,7 @@ public interface NCElement extends NCMetadata, Serializable {
     }
 
     /**
-     * Whether or not this element allows non-stopword words, the gaps, in its multi-word synonyms.
+     * Whether or not this element allows the non-stop words gaps in its multi-word synonyms.
      * <p>
      * This property overrides the value from {@link NCModelView#isSparse()}.
      * One should use this property if model's value isn't applicable to this element.
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 e7ea299..16c161d 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCModelView.java
@@ -785,7 +785,7 @@ public interface NCModelView extends NCMetadata {
     }
 
     /**
-     * Whether or not this model elements allows non-stopword words, the gaps, in their multi-word synonyms.
+     * Whether or not this model elements allows non-stop words gaps in their multi-word synonyms.
      * <p>
      * Note that individual model elements can override this property using {@link NCElement#isSparse()}
      * method.
@@ -1127,7 +1127,7 @@ public interface NCModelView extends NCMetadata {
      * about it and exclude it from conversation context. In other words, the term "Chicago" is no longer in
      * conversation's short-term-memory.
      * <p>
-     * Note that both conversation {@link #getConversationTimeout() timeout} and {@link #getConversationDepth() depth}
+     * Note that both conversation timeout and {@link #getConversationDepth() depth}
      * combined define the expiration policy for the conversation management. These two properties allow to
      * fine tune for different types of dialogs. For example, setting longer timeout and smaller depth mimics
      * slow-moving but topic-focused conversation. Alternatively, settings shorter timeout and longer depth better
@@ -1159,7 +1159,7 @@ public interface NCModelView extends NCMetadata {
      * about it and exclude it from conversation context. In other words, the term "Chicago" is no longer in
      * conversation's short-term-memory.
      * <p>
-     * Note that both conversation {@link #getConversationTimeout() timeout} and {@link #getConversationDepth() depth}
+     * Note that both conversation {@link #getConversationTimeout() timeout} and depth
      * combined define the expiration policy for the conversation management. These two properties allow to
      * fine tune for different types of dialogs. For example, setting longer timeout and smaller depth mimics
      * slow-moving but topic-focused conversation. Alternatively, settings shorter timeout and longer depth better
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java
index ae84ea5..ed93a07 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java
@@ -64,7 +64,7 @@ public class NCResult implements Serializable {
     /** Sequence of tokens represents a fully parsed (see {@link NCContext#getVariants()} method) user input. */
     private Collection<NCToken> tokens;
 
-    /** ID of the intent defined externally. */
+    /** ID of the intent. */
     private String intentId;
     
     /**
@@ -225,7 +225,7 @@ public class NCResult implements Serializable {
     /**
      * Get optional intent ID. 
      *
-     * @return Intent ID or {@code null} if intent ID was not provided.
+     * @return Intent ID or {@code null} if intent ID was not available.
      */
     public String getIntentId() {
         return intentId;