[incubator-nlpcraft] branch master updated: Update NCEntity.scala

[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 3591a085 Update NCEntity.scala
3591a085 is described below

commit 3591a08502932016cd1455c1faeaecb16c9aeb4f
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Tue Aug 23 11:51:06 2022 -0700

    Update NCEntity.scala
---
 .../main/scala/org/apache/nlpcraft/NCEntity.scala  | 43 ++++++++++++----------
 1 file changed, 24 insertions(+), 19 deletions(-)

diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.scala
index f3b27426..96c77bd1 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCEntity.scala
@@ -18,57 +18,62 @@
 package org.apache.nlpcraft
 
 /**
-  * An entity is a collection if one or more {@link NCToken tokens}. An entity typically has a
+  * An entity is a collection if one or more [[NCToken tokens]]. An entity typically has a
   * consistent semantic meaning and usually denotes a real-world object, such as persons, locations, number,
   * date and time, organizations, products, etc. - where such objects can be abstract or have a physical existence.
-  * Entities are produced by {@link NCEntityParser}. See {@link NCPipeline} for documentation on the entities in the
+  * Entities are produced by [[NCEntityParser]]. See [[NCPipeline]] for documentation on the entities in the
   * overall processing pipeline.
   *
-  * <span class="hdr">Metadata</span>
-  * Note that both {@link NCToken} and {@link NCEntity} interfaces extend {@link NCPropertyMap} interface
+  * Note that both [[NCToken]] and [[NCEntity]] interfaces extend [[NCPropertyMap]] trait
   * 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 NCEntity extends NCPropertyMap:
 
     /**
       * Gets the list of tokens this entity is comprised of. Returned list is never empty or `null`.
       *
-      * @return List of tokens that are part of this entity. */
+      * @return List of tokens that are part of this entity.
+      */
     def getTokens: List[NCToken]
 
     /**
       * Joins all tokens' text with trimming using space as a delimiter. This function does not cache the
       * result and performs text construction on each call. Make sure to cache the result to avoid
-      * unnecessary parasitic workload if and when method {@link # getTokens ( )} does not change.
+      * unnecessary parasitic workload if and when method [[getTokens]] does not change.
       *
       * @return Constructed text value representation of this entity. Note that returned value is not
-      * cached and created anew every time this method is called. */
+      *     cached and created anew every time this method is called.
+      */
     def mkText: String = getTokens.map(_.getText.trim).mkString(" ").trim
 
     /**
       * Gets ID of the request this entity is part of.
       *
-      * @return ID of the request this entity is part of. */
+      * @return ID of the request this entity is part of.
+      */
     def getRequestId: String
 
     /**
       * Gets optional set of groups this entity belongs to.
       *
-      * @return Optional set of groups this entity belongs to. Returned set can be empty but never `null`. */
+      * @return Optional set of groups this entity belongs to. Returned set can be empty but never `null`.
+      */
     def getGroups: Set[String] = Set(getId)
 
     /**
       * Gets globally unique ID of this entity.
       *
-      * @return Globally unique ID of this entity. */
+      * @return Globally unique ID of this entity.
+      */
     def getId: String