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 014f91d9 WIP on scaladoc.
014f91d9 is described below
commit 014f91d9edd97d0b2f09073af7ac281e00ce95d7
Author: Aaron Radzinski <[email protected]>
AuthorDate: Tue Aug 23 11:58:07 2022 -0700
WIP on scaladoc.
---
.../org/apache/nlpcraft/NCEntityEnricher.scala | 27 +++++++++++-----------
.../scala/org/apache/nlpcraft/NCEntityMapper.scala | 24 +++++++++----------
.../scala/org/apache/nlpcraft/NCEntityParser.scala | 26 +++++++++++----------
.../org/apache/nlpcraft/NCEntityValidator.scala | 20 ++++++++--------
.../scala/org/apache/nlpcraft/NCIntentMatch.scala | 6 ++---
.../scala/org/apache/nlpcraft/NCIntentSkip.scala | 10 ++++----
.../scala/org/apache/nlpcraft/NCLifecycle.scala | 19 ++++++++-------
.../scala/org/apache/nlpcraft/NCPropertyMap.scala | 6 ++---
.../main/scala/org/apache/nlpcraft/NCToken.scala | 18 +++++++--------
.../org/apache/nlpcraft/NCTokenEnricher.scala | 18 +++++++--------
.../scala/org/apache/nlpcraft/NCTokenParser.scala | 18 +++++++--------
.../org/apache/nlpcraft/NCTokenValidator.scala | 18 +++++++--------
.../main/scala/org/apache/nlpcraft/NCVariant.scala | 2 +-
13 files changed, 109 insertions(+), 103 deletions(-)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.scala
index 87761372..84d98fc2 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityEnricher.scala
@@ -19,21 +19,21 @@ package org.apache.nlpcraft
/**
* A pipeline component that enrichers entities by settings their properties.
- * See {@link NCPipeline} for documentation on the overall processing
pipeline. Note that this is
+ * See [[NCPipeline]] for documentation on the overall processing pipeline.
Note that this is
* an optional component in the pipeline.
*
- * @see NCPipeline#getEntityEnrichers()
- * @see NCEntity
- * @see NCToken
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper
+ * @see [[NCPipeline.getEntityEnrichers]]
+ * @see [[NCEntity]]
+ * @see [[NCToken]]
+ * @see [[NCTokenParser]]
+ * @see [[NCTokenEnricher]]
+ * @see [[NCTokenValidator]]
+ * @see [[NCEntityParser]]
+ * @see [[NCEntityEnricher]]
+ * @see [[NCEntityValidator]]
+ * @see [[NCEntityMapper]]
*/
-trait NCEntityEnricher extends NCLifecycle :
+trait NCEntityEnricher extends NCLifecycle:
/**
* Enriches given list of entities by settings their properties.
*
@@ -41,5 +41,6 @@ trait NCEntityEnricher extends NCLifecycle :
* @param cfg Configuration of the model this component is associated
with.
* @param ents List of entities to enrich.
* @throws NCException Thrown in case of any errors.
- * @see NCPropertyMap */
+ * @see [[NCPropertyMap]]
+ */
def enrich(req: NCRequest, cfg: NCModelConfig, ents: List[NCEntity]): Unit
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.scala
index 7e45ca02..0948c93c 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityMapper.scala
@@ -20,19 +20,19 @@ package org.apache.nlpcraft
/**
* A pipeline component that allows to map one set of entities into another
after the entities were parsed
* and enriched. Entity mapper is an optional component and the pipeline can
have zero or more entity mappers. Mappers
- * are typically used for combine several existing entities into a new one
without necessarily touching the entity
- * parser or enrichers. See {@link NCPipeline} for documentation on the
overall processing pipeline.
+ * are typically used for combining several existing entities into a new one
without necessarily touching the entity
+ * parser or enrichers. See [[NCPipeline]] for documentation on the overall
processing pipeline.
*
- * @see NCPipeline#getEntityMappers()
- * @see NCEntity
- * @see NCToken
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper
+ * @see [[NCPipeline.getEntityMappers]]
+ * @see [[NCEntity]]
+ * @see [[NCToken]]
+ * @see [[NCTokenParser]]
+ * @see [[NCTokenEnricher]]
+ * @see [[NCTokenValidator]]
+ * @see [[NCEntityParser]]
+ * @see [[NCEntityEnricher]]
+ * @see [[NCEntityValidator]]
+ * @see [[NCEntityMapper]]
*/
trait NCEntityMapper extends NCLifecycle:
/**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.scala
index 343aa562..cd989705 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityParser.scala
@@ -19,19 +19,20 @@ package org.apache.nlpcraft
/**
* A pipeline component that converts list of tokens into the list of
entities.
- * See {@link NCPipeline} for documentation on the overall processing
pipeline. Note that pipeline
+ * See [[NCPipeline]] for documentation on the overall processing pipeline.
Note that pipeline
* must have at least one entity parser.
*
- * @see NCPipeline#getEntityParsers()
- * @see NCEntity
- * @see NCToken
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper */
+ * @see [[NCPipeline.getEntityParsers]]
+ * @see [[NCEntity]]
+ * @see [[NCToken]]
+ * @see [[NCTokenParser]]
+ * @see [[NCTokenEnricher]]
+ * @see [[NCTokenValidator]]
+ * @see [[NCEntityParser]]
+ * @see [[NCEntityEnricher]]
+ * @see [[NCEntityValidator]]
+ * @see [[NCEntityMapper]]
+ */
trait NCEntityParser extends NCLifecycle:
/**
* Converts, parses, given list of tokens into the list of entities.
@@ -40,6 +41,7 @@ trait NCEntityParser extends NCLifecycle:
* @param cfg Configuration of the model this component is associated
with.
* @param toks List of tokens to convert.
* @return List of parsed entities, potentially empty but never `null`.
- * @@throws NCException Thrown in case of any errors. */
+ * @throws NCException Thrown in case of any errors.
+ */
def parse(req: NCRequest, cfg: NCModelConfig, toks: List[NCToken]):
List[NCEntity]
diff --git
a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
index 2ba7e195..ff1a570d 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
@@ -22,16 +22,16 @@ package org.apache.nlpcraft
* See {@link NCPipeline} for documentation on the overall processing
pipeline. Note that this is an
* optional component.
*
- * @see NCPipeline#getEntityValidators()
- * @see NCEntity
- * @see NCToken
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper */
+ * @see [[NCPipeline#getEntityValidators()
+ * @see [[NCEntity
+ * @see [[NCToken
+ * @see [[NCTokenParser
+ * @see [[NCTokenEnricher
+ * @see [[NCTokenValidator
+ * @see [[NCEntityParser
+ * @see [[NCEntityEnricher
+ * @see [[NCEntityValidator
+ * @see [[NCEntityMapper */
trait NCEntityValidator extends NCLifecycle:
/**
*
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
index 24fc9ede..adb5a72a 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentMatch.scala
@@ -37,7 +37,7 @@ trait NCIntentMatch:
*
* @return List of lists of entities representing matched intent.
* @see #getVariant()
- * @see NCIntentTerm */
+ * @see [[NCIntentTerm */
def getIntentEntities: List[List[NCEntity]]
/**
@@ -47,7 +47,7 @@ trait NCIntentMatch:
*
* @param idx Index of the term (starting from <code>0</code>).
* @return List of entities, potentially `null`, for given term.
- * @see NCIntentTerm
+ * @see [[NCIntentTerm
* @see #getTermEntities(String) */
def getTermEntities(idx: Int): List[NCEntity]
@@ -58,7 +58,7 @@ trait NCIntentMatch:
*
* @param termId ID of the term for which to get entities.
* @return List of entities, potentially `null`, for given term.
- * @see NCIntentTerm
+ * @see [[NCIntentTerm
* @see #getTermEntities(int) */
def getTermEntities(termId: String): List[NCEntity]
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentSkip.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentSkip.scala
index 10647c0d..89176341 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentSkip.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCIntentSkip.scala
@@ -28,9 +28,9 @@ package org.apache.nlpcraft
* matching can happen inside the intent callback's user logic. If it is
determined that intent in fact does
* not match then throwing this exception allows to try next best matching
intent, if any.
*
- * @see NCIntent
- * @see NCIntentTerm
- * @see NCIntentRef
- * @see NCIntentMatch
- * @see NCModel#onMatchedIntent(NCIntentMatch) */
+ * @see [[NCIntent
+ * @see [[NCIntentTerm
+ * @see [[NCIntentRef
+ * @see [[NCIntentMatch
+ * @see [[NCModel#onMatchedIntent(NCIntentMatch) */
class NCIntentSkip(msg: String, cause: Throwable = null) extends
NCException(msg, cause)
\ No newline at end of file
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala
index 7c063ec0..43525ef6 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCLifecycle.scala
@@ -20,21 +20,24 @@ package org.apache.nlpcraft
/**
* Lifecycle callbacks for various pipeline components.
*
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator */
+ * @see [[NCTokenParser]]
+ * @see [[NCTokenEnricher]]
+ * @see [[NCTokenValidator]]
+ * @see [[NCEntityParser]]
+ * @see [[NCEntityEnricher]]
+ * @see [[NCEntityValidator]]
+ */
trait NCLifecycle:
/**
* Called when the component starts. Default implementation is no-op.
*
- * @param cfg Configuration of the model this component is associated
with. */
+ * @param cfg Configuration of the model this component is associated
with.
+ */
def onStart(cfg: NCModelConfig): Unit = () // No-op.
/**
* Called when the component stops. Default implementation is no-op.
*
- * @param cfg Configuration of the model this component is associated
with. */
+ * @param cfg Configuration of the model this component is associated
with.
+ */
def onStop(cfg: NCModelConfig): Unit = () // No-op.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala
index 5565b7fa..040f4538 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPropertyMap.scala
@@ -20,9 +20,9 @@ package org.apache.nlpcraft
/**
* Map-like container that provides support for mutable runtime-only
properties or metadata.
*
- * @see NCPropertyMapAdapter
- * @see NCToken
- * @see NCEntity */
+ * @see [[NCPropertyMapAdapter
+ * @see [[NCToken
+ * @see [[NCEntity */
trait NCPropertyMap:
/**
* Returns the value to which the specified key is mapped, or `null` if
this map contains no mapping for the key.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.scala
index a9208693..9b140bc8 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCToken.scala
@@ -27,15 +27,15 @@ package org.apache.nlpcraft
* 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 NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper */
+ * @see [[NCEntity
+ * @see [[NCToken
+ * @see [[NCTokenParser
+ * @see [[NCTokenEnricher
+ * @see [[NCTokenValidator
+ * @see [[NCEntityParser
+ * @see [[NCEntityEnricher
+ * @see [[NCEntityValidator
+ * @see [[NCEntityMapper */
trait NCToken extends NCPropertyMap:
/**
* Gets the text of this token.
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.scala
index f9d4739b..d021343e 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenEnricher.scala
@@ -19,15 +19,15 @@ package org.apache.nlpcraft
/**
*
- * @see NCEntity
- * @see NCToken
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper */
+ * @see [[NCEntity
+ * @see [[NCToken
+ * @see [[NCTokenParser
+ * @see [[NCTokenEnricher
+ * @see [[NCTokenValidator
+ * @see [[NCEntityParser
+ * @see [[NCEntityEnricher
+ * @see [[NCEntityValidator
+ * @see [[NCEntityMapper */
trait NCTokenEnricher extends NCLifecycle:
/**
*
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.scala
index 9ce8d495..973fdfbd 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenParser.scala
@@ -23,15 +23,15 @@ package org.apache.nlpcraft
* 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 NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper */
+ * @see [[NCEntity
+ * @see [[NCToken
+ * @see [[NCTokenParser
+ * @see [[NCTokenEnricher
+ * @see [[NCTokenValidator
+ * @see [[NCEntityParser
+ * @see [[NCEntityEnricher
+ * @see [[NCEntityValidator
+ * @see [[NCEntityMapper */
trait NCTokenParser:
/**
*
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.scala
index 388352bd..f6ec9331 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCTokenValidator.scala
@@ -19,15 +19,15 @@ package org.apache.nlpcraft
/**
*
- * @see NCEntity
- * @see NCToken
- * @see NCTokenParser
- * @see NCTokenEnricher
- * @see NCTokenValidator
- * @see NCEntityParser
- * @see NCEntityEnricher
- * @see NCEntityValidator
- * @see NCEntityMapper */
+ * @see [[NCEntity
+ * @see [[NCToken
+ * @see [[NCTokenParser
+ * @see [[NCTokenEnricher
+ * @see [[NCTokenValidator
+ * @see [[NCEntityParser
+ * @see [[NCEntityEnricher
+ * @see [[NCEntityValidator
+ * @see [[NCEntityMapper */
trait NCTokenValidator extends NCLifecycle:
/**
*
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
index 15485f16..f6f94f94 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCVariant.scala
@@ -22,7 +22,7 @@ package org.apache.nlpcraft
* query 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(NCVariant) */
trait NCVariant:
/**
* Gets the list of entities for this variant.
