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 438dab48 scaladoc.
438dab48 is described below
commit 438dab4814763a3fb5ed12d19f58d470254a2bf4
Author: Aaron Radzinski <[email protected]>
AuthorDate: Wed Aug 31 13:06:58 2022 -0700
scaladoc.
---
.../scala/org/apache/nlpcraft/NCIntentMatch.scala | 35 ++++++++++++----------
.../main/scala/org/apache/nlpcraft/NCVariant.scala | 7 +++--
2 files changed, 23 insertions(+), 19 deletions(-)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
index adb5a72a..c04b81e0 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
@@ -17,14 +17,15 @@
package org.apache.nlpcraft
+import scala.annotation.StaticAnnotation
+
/**
- *
+ * Descriptor of the matched intent.
*/
trait NCIntentMatch:
/**
* Gets ID of the matched intent.
- *
- * @return ID of the matched intent. */
+ */
def getIntentId: String
/**
@@ -32,29 +33,31 @@ trait NCIntentMatch:
* where a `null` sub-list defines an optional term. Order and index of
sub-lists corresponds
* to the order and index of terms in the matching intent. Number of
sub-lists will always be the same
* as the number of terms in the matched intent.
- * <p>
- * Consider using {@link NCIntentTerm} annotation instead for simpler
access to the intent entities.
+ *
+ * Consider using [[NCIntentTerm]] annotation instead for simpler access
to the intent entities.
*
* @return List of lists of entities representing matched intent.
- * @see #getVariant()
- * @see [[NCIntentTerm */
+ * @see [[getVariant()]]
+ * @see [[NCIntentTerm]]
+ */
def getIntentEntities: List[List[NCEntity]]
/**
- * Gets entities for given term. This is a companion method for {@link #
getIntentEntities ( )}.
- * <p>
- * Consider using {@link NCIntentTerm} annotation instead for simpler
access to the intent entities.
+ * Gets entities for given term. This is a companion method for
[[getIntentEntities()]] method.
*
- * @param idx Index of the term (starting from <code>0</code>).
+ * Consider using [[NCIntentTerm]] annotation instead for simpler access
to the intent entities.
+ *
+ * @param idx Index of the term (starting from `0`).
* @return List of entities, potentially `null`, for given term.
- * @see [[NCIntentTerm
- * @see #getTermEntities(String) */
+ * @see [[NCIntentTerm]]
+ * @see [[getTermEntities()]]
+ */
def getTermEntities(idx: Int): List[NCEntity]
/**
- * Gets entities for given term. This is a companion method for {@link #
getIntentEntities ( )}.
- * <p>
- * Consider using {@link NCIntentTerm} annotation instead for simpler
access to the intent entities.
+ * Gets entities for given term. This is a companion method for
[[getIntentEntities()]].
+ *
+ * Consider using [[NCIntentTerm]] annotation instead for simpler access
to the intent entities.
*
* @param termId ID of the term for which to get entities.
* @return List of entities, potentially `null`, for given term.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
index f6f94f94..e46b0ef5 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
@@ -18,11 +18,12 @@
package org.apache.nlpcraft
/**
- * A parsing variant is a list of entities defining one possible parsing of
the ipnut query. Note that a given input
- * query can have one or more possible different parsing variants. Depending
on model configuration a user input
+ * A parsing variant is a list of entities defining one possible parsing of
the input query. Note that a given input
+ * can have one or more possible different parsing variants. Depending on
model configuration a user input
* can produce hundreds or even thousands of parsing variants.
*
- * @see [[NCModel#onVariant(NCVariant) */
+ * @see [[NCModel.onVariant()]]
+ */
trait NCVariant:
/**
* Gets the list of entities for this variant.
