[incubator-nlpcraft] branch master updated: scaladoc.

[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


The following commit(s) were added to refs/heads/master by this push:
     new 6c4a22e7 scaladoc.
6c4a22e7 is described below

commit 6c4a22e7d159c5b8fb4981cf1e7cb1c9b0d8e8f6
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Sun Aug 21 11:00:33 2022 -0700

    scaladoc.
---
 nlpcraft/src/main/scala/org/apache/nlpcraft/NCContext.scala  |  4 ++--
 .../src/main/scala/org/apache/nlpcraft/NCConversation.scala  | 12 ++++++------
 nlpcraft/src/main/scala/org/apache/nlpcraft/NCCuration.scala |  3 ++-
 .../main/scala/org/apache/nlpcraft/NCDialogFlowItem.scala    |  7 ++++---
 4 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCContext.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCContext.scala
index d5558458..b19093a1 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCContext.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCContext.scala
@@ -20,7 +20,7 @@ package org.apache.nlpcraft
 /**
   * A context containing a fully parsed data from the input query.
   *
-  * @see NCModel#onContext(NCContext)
+  * @see [[NCModel.onContext()]]
   */
 trait NCContext:
     /**
@@ -55,7 +55,7 @@ trait NCContext:
       * Gets the list of parsing variants. Returned list always contains as least one parsing variant.
       *
       * @return A non-empty list of parsing variants.
-      * @see NCModel#onVariant(NCVariant)
+      * @see [[NCModel.onVariant()]]
       */
     def getVariants: List[NCVariant]
 
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCConversation.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCConversation.scala
index a57cecbf..68cb6a51 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCConversation.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCConversation.scala
@@ -35,17 +35,17 @@ package org.apache.nlpcraft
   * conversation since the last mention.
   *
   * You can also maintain user state-machine between requests using conversation's session. Conversation's
-  * [[NCConversation#getData data]] is a mutable thread-safe container that can hold any arbitrary user data
+  * [[NCConversation.getData data]] is a mutable thread-safe container that can hold any arbitrary user data
   * while supporting the same expiration logic as the rest of the conversation elements (i.e. tokens and
   * previously matched intent IDs).
   *
   * Conversation expiration policy is configured by two configuration properties:
-  *  - [[NCModelConfig#getConversationDepth]]
-  *  - [[NCModelConfig#getConversationTimeout]]
+  *  - [[NCModelConfig.getConversationDepth]]
+  *  - [[NCModelConfig.getConversationTimeout]]
   *
-  * @see [[NCContext#getConversation()]]
-  * @see [[NCModelConfig#getConversationDepth()]]
-  * @see [[NCModelConfig#getConversationTimeout()]]
+  * @see [[NCContext.getConversation()]]
+  * @see [[NCModelConfig.getConversationDepth()]]
+  * @see [[NCModelConfig.getConversationTimeout()]]
   */
 trait NCConversation:
     /**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCCuration.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCCuration.scala
index b49abf58..e7bff0f8 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCCuration.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCCuration.scala
@@ -23,7 +23,8 @@ package org.apache.nlpcraft
   *
   * Note that NLPCraft does not handle the curation process itself but only allows to indicate the curation
   * request by throwing this exception. Curation is a special type of rejection. The user code is responsible for
-  * he actual handling of the curation logic.
+  * he actual handling of the curation logic, e.g. giving the user an option to fix the input and resubmitting the
+  * request.
   *
   * @param msg Curation message.
   * @param cause Optional cause of this exception.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.scala
index d82b13b9..2bf5eb26 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.scala
@@ -22,7 +22,7 @@ package org.apache.nlpcraft
   * represents a snapshot of winning intent's match and its associated data. List of dialog flow items
   * is passed into a custom user-defined dialog flow match method.
   *
-  * @see NCConversation#getDialogFlow()
+  * @see [[NCConversation#getDialogFlow()]]
   */
 trait NCDialogFlowItem:
     /**
@@ -40,8 +40,9 @@ trait NCDialogFlowItem:
     def getRequest: NCRequest
 
     /**
-      * Gets the winning intent's result.
+      * Gets the optional winning intent's result. Note that result is not available if the caller used
+      * [[NCModelClient.debugAsk()]] method to initiate the request.
       *
-      * @return Winning intent's result. // TODO: None for debugAsk.
+      * @return Winning intent's result.
       */
     def getResult: Option[NCResult]