[incubator-nlpcraft] branch master updated: WIP on scaladoc.

[aradzinski]

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 63847784 WIP on scaladoc.
63847784 is described below

commit 6384778455db7176a45c8f42685665daec34f9a7
Author: Aaron Radzinski <aradzin...@datalingvo.com>
AuthorDate: Tue Aug 23 15:45:29 2022 -0700

    WIP on scaladoc.
---
 .../org/apache/nlpcraft/NCEntityValidator.scala    | 26 ++++++++++++----------
 .../scala/org/apache/nlpcraft/NCException.scala    |  6 ++++-
 2 files changed, 19 insertions(+), 13 deletions(-)

diff --git 
a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
index ff1a570d..ef099f65 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntityValidator.scala
@@ -19,25 +19,27 @@ package org.apache.nlpcraft
 
 /**
   * A pipeline components that validates the final list of parsed and enriched 
entities.
-  * See {@link NCPipeline} for documentation on the overall processing 
pipeline. Note that this is an
+  * See [[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:
     /**
       *
       * @param req Input request descriptor.
       * @param cfg Configuration of the model this component is associated 
with.
       * @param ents List of entities to validate.
-      * @@throws NCException Thrown in case of any validation violations. */
+      * @throws NCException Thrown in case of any validation violations.
+      */
     def validate(req: NCRequest, cfg: NCModelConfig, ents: List[NCEntity]): 
Unit
 
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCException.scala 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCException.scala
index 419d1f9c..cb2b4eea 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCException.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCException.scala
@@ -18,5 +18,9 @@
 package org.apache.nlpcraft
 
 /**
-  * Base NLPCraft exception. */
+  * Base NLPCraft exception.
+  *
+  * @param msg Error message.
+  * @param cause Optional cause exception.
+  */
 class NCException(msg: String, cause: Throwable = null) extends 
RuntimeException(msg, cause)
\ No newline at end of file