You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2022/09/11 21:39:20 UTC
[incubator-nlpcraft] branch master updated: WIP scaladoc.
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 114b4aa0 WIP scaladoc.
114b4aa0 is described below
commit 114b4aa0728d240eeb5d23d92e148ee1b918a47f
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Sun Sep 11 14:39:15 2022 -0700
WIP scaladoc.
---
.../nlpcraft/examples/pizzeria/PizzeriaModel.scala | 8 -------
.../nlpcraft/examples/pizzeria/PizzeriaOrder.scala | 4 ----
.../scala/org/apache/nlpcraft/NCModelClient.scala | 3 ---
.../scala/org/apache/nlpcraft/NCPipeline.scala | 5 -----
.../org/apache/nlpcraft/NCPipelineBuilder.scala | 1 -
.../main/scala/org/apache/nlpcraft/NCResult.scala | 3 ---
.../nlpcraft/internal/antlr4/NCCompilerUtils.scala | 1 -
.../nlpcraft/internal/ascii/NCAsciiTable.scala | 3 ---
.../internal/conversation/NCConversationData.scala | 1 -
.../conversation/NCConversationManager.scala | 1 -
.../internal/dialogflow/NCDialogFlowManager.scala | 2 --
.../internal/impl/NCModelPipelineHelper.java | 9 --------
.../internal/impl/NCModelPipelineManager.scala | 4 ----
.../nlpcraft/internal/impl/NCModelScanner.scala | 9 --------
.../nlpcraft/internal/intent/NCIDLTerm.scala | 1 -
.../intent/compiler/NCIDLCodeGenerator.scala | 17 ---------------
.../internal/intent/compiler/NCIDLCompiler.scala | 10 +--------
.../intent/matcher/NCIntentSolverManager.scala | 11 ----------
.../nlpcraft/internal/makro/NCMacroCompiler.scala | 3 ---
.../nlpcraft/internal/makro/NCMacroParser.scala | 2 --
.../nlpcraft/internal/util/NCResourceReader.scala | 7 ------
.../apache/nlpcraft/internal/util/NCUtils.scala | 25 ----------------------
.../nlp/parsers/NCOpenNLPEntityParser.scala | 1 -
.../nlpcraft/nlp/parsers/NCSemanticElement.scala | 5 -----
.../nlp/parsers/NCSemanticEntityParser.scala | 5 -----
.../nlpcraft/nlp/parsers/NCSemanticStemmer.scala | 1 -
.../nlp/parsers/impl/NCSemanticSourceReader.scala | 1 -
.../parsers/impl/NCSemanticSynonymsProcessor.scala | 3 ---
.../internal/impl/NCModelCallbacksSpec.scala | 3 ---
.../nlpcraft/internal/impl/NCModelClientSpec.scala | 1 -
.../internal/impl/scan/NCTestModelScala.scala | 1 -
.../intent/compiler/functions/NCIDLFunctions.scala | 6 ------
.../apache/nlpcraft/nlp/util/NCTestRequest.scala | 1 -
.../org/apache/nlpcraft/nlp/util/NCTestUtils.scala | 5 -----
34 files changed, 1 insertion(+), 162 deletions(-)
diff --git a/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaModel.scala b/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaModel.scala
index 242f3b46..a2e51833 100644
--- a/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaModel.scala
+++ b/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaModel.scala
@@ -134,7 +134,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
/**
*
* @param im
- * @return
*/
@NCIntent("intent=yes term(yes)={# == 'ord:yes'}")
def onYes(using ctx: NCContext, im: NCIntentMatch): NCResult = doRequest(
@@ -148,7 +147,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
/**
*
* @param im
- * @return
*/
@NCIntent("intent=no term(no)={# == 'ord:no'}")
def onNo(using ctx: NCContext, im: NCIntentMatch): NCResult = doRequest(
@@ -160,7 +158,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
/**
*
* @param im
- * @return
*/
@NCIntent("intent=stop term(stop)={# == 'ord:stop'}")
// It doesn't depend on order validity and dialog state.
@@ -169,7 +166,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
/**
*
* @param im
- * @return
*/
@NCIntent("intent=status term(status)={# == 'ord:status'}")
def onStatus(using ctx: NCContext, im: NCIntentMatch): NCResult = doRequest(
@@ -181,7 +177,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
/**
*
* @param im
- * @return
*/
@NCIntent("intent=finish term(finish)={# == 'ord:finish'}")
def onFinish(using ctx: NCContext, im: NCIntentMatch): NCResult = doRequest(
@@ -193,7 +188,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
/**
*
* @param im
- * @return
*/
@NCIntent("intent=menu term(menu)={# == 'ord:menu'}")
// It doesn't depend and doesn't influence on order validity and dialog state.
@@ -204,7 +198,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
* @param im
* @param ps
* @param ds
- * @return
*/
@NCIntent("intent=order term(ps)={# == 'ord:pizza'}* term(ds)={# == 'ord:drink'}*")
def onOrder(using ctx: NCContext, im: NCIntentMatch, @NCIntentTerm("ps") ps: List[NCEntity], @NCIntentTerm("ds") ds: List[NCEntity]): NCResult = doRequest(
@@ -219,7 +212,6 @@ class PizzeriaModel extends NCModelAdapter(NCModelConfig("nlpcraft.pizzeria.ex",
*
* @param im
* @param size
- * @return
*/
@NCIntent("intent=orderSpecify term(size)={# == 'ord:pizza:size'}")
def onOrderSpecify(using ctx: NCContext, im: NCIntentMatch, @NCIntentTerm("size") size: NCEntity): NCResult = doRequest(
diff --git a/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaOrder.scala b/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaOrder.scala
index 5b5876d9..e2abbff9 100644
--- a/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaOrder.scala
+++ b/nlpcraft-examples/pizzeria/src/main/java/org/apache/nlpcraft/examples/pizzeria/PizzeriaOrder.scala
@@ -66,13 +66,11 @@ class PizzeriaOrder:
/**
*
- * @return
*/
def isEmpty: Boolean = pizzas.isEmpty && drinks.isEmpty
/**
*
- * @return
*/
def isValid: Boolean = !isEmpty && findPizzaWithoutSize.isEmpty
@@ -105,7 +103,6 @@ class PizzeriaOrder:
/**
*
- * @return
*/
def findPizzaWithoutSize: Option[Pizza] = pizzas.find(_.size.isEmpty)
@@ -121,7 +118,6 @@ class PizzeriaOrder:
case None => false
/**
*
- * @return
*/
def getState: PizzeriaOrderState = state
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelClient.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelClient.scala
index a339fb1c..69b129f8 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelClient.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCModelClient.scala
@@ -76,7 +76,6 @@ class NCModelClient(mdl: NCModel) extends LazyLogging, AutoCloseable:
* @param data
* @param usrId
* @param typ
- * @return
*/
private def ask0(txt: String, data: Map[String, Any], usrId: String, typ: NCIntentSolveType): Either[NCResult, NCMatchedCallback] =
val plData = plMgr.prepare(txt, data, usrId)
@@ -110,7 +109,6 @@ class NCModelClient(mdl: NCModel) extends LazyLogging, AutoCloseable:
* @param txt
* @param data
* @param usrId
- * @return
*/
def ask(txt: String, usrId: String, data: Map[String, AnyRef] = Map.empty): NCResult =
require(txt != null, "Input text cannot be null.")
@@ -168,7 +166,6 @@ class NCModelClient(mdl: NCModel) extends LazyLogging, AutoCloseable:
* @param data
* @param usrId
* @param saveHist
- * @return
*/
def debugAsk(txt: String, usrId: String, saveHist: Boolean, data: Map[String, AnyRef] = Map.empty): NCMatchedCallback =
require(txt != null, "Input text cannot be null.")
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala
index ea310681..c8c1d61f 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala
@@ -65,31 +65,26 @@ trait NCPipeline:
/**
*
- * @return
*/
def getTokenEnrichers: List[NCTokenEnricher] = List.empty
/**
*
- * @return
*/
def getEntityEnrichers: List[NCEntityEnricher] = List.empty
/**
*
- * @return
*/
def getTokenValidators: List[NCTokenValidator] = List.empty
/**
*
- * @return
*/
def getEntityValidators: List[NCEntityValidator] = List.empty
/**
*
- * @return
*/
def getVariantFilter: Option[NCVariantFilter] = None
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipelineBuilder.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipelineBuilder.scala
index 9a1690a5..60b3d39c 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipelineBuilder.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipelineBuilder.scala
@@ -209,7 +209,6 @@ class NCPipelineBuilder:
*
* @param lang
* @param mdlSrc
- * @return
*/
def withSemantic(lang: String, mdlSrc: String): NCPipelineBuilder =
require(lang != null, "Language cannot be null.")
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResult.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResult.scala
index db9d865c..8226225a 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResult.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCResult.scala
@@ -26,7 +26,6 @@ object NCResult:
* @param body
* @param resultType
* @param intentId
- * @return
*/
def apply(body: Any, resultType: NCResultType, intentId: String): NCResult =
new NCResult():
@@ -38,7 +37,6 @@ object NCResult:
*
* @param body
* @param resultType
- * @return
*/
def apply(body: Any, resultType: NCResultType): NCResult =
new NCResult():
@@ -49,7 +47,6 @@ object NCResult:
/**
*
* @param body
- * @return
*/
def apply(body: Any): NCResult =
new NCResult() :
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/antlr4/NCCompilerUtils.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/antlr4/NCCompilerUtils.scala
index 1940b254..f76fb879 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/antlr4/NCCompilerUtils.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/antlr4/NCCompilerUtils.scala
@@ -24,7 +24,6 @@ object NCCompilerUtils:
*
* @param in
* @param charPos
- * @return
*/
def mkErrorHolder(in: String, charPos: Int): NCCompilerErrorHolder =
val in0 = in.strip()
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/ascii/NCAsciiTable.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/ascii/NCAsciiTable.scala
index 3a586fe6..728b96c1 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/ascii/NCAsciiTable.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/ascii/NCAsciiTable.scala
@@ -270,7 +270,6 @@ class NCAsciiTable:
*
* @param maxWidth
* @param lines
- * @return
*/
private def breakUpByNearestSpace(maxWidth: Int, lines: Seq[String]): Seq[String] =
lines.flatMap(line => {
@@ -309,7 +308,6 @@ class NCAsciiTable:
*
* @param style
* @param lines
- * @return
*/
private def mkStyledCell(style: String, lines: Any*): Cell =
val st = Style(style)
@@ -439,7 +437,6 @@ class NCAsciiTable:
*
* @param crs
* @param cor
- * @return
*/
def mkAsciiLine(crs: String, cor: String): String =
s"${space(margin.left)}$crs${dash(cor, tableW)}$crs${space(margin.right)}\n"
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationData.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationData.scala
index e3dfba4e..e6a8ed06 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationData.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationData.scala
@@ -197,7 +197,6 @@ case class NCConversationData(
/**
*
- * @return
*/
def getEntities: List[NCEntity] = stm.synchronized {
val reqIds = ctx.map(_.getRequestId).distinct.zipWithIndex.toMap
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationManager.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationManager.scala
index 7a47de2c..9c4c13c8 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationManager.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/conversation/NCConversationManager.scala
@@ -70,7 +70,6 @@ class NCConversationManager(cfg: NCModelConfig) extends LazyLogging:
/**
*
- * @return
*/
def start(): Unit =
gc = NCUtils.mkThread("conv-mgr-gc", cfg.getId) { t =>
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/dialogflow/NCDialogFlowManager.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/dialogflow/NCDialogFlowManager.scala
index 5b9be5e0..0a47aa47 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/dialogflow/NCDialogFlowManager.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/dialogflow/NCDialogFlowManager.scala
@@ -64,7 +64,6 @@ class NCDialogFlowManager(cfg: NCModelConfig) extends LazyLogging:
* @param intentMatch
* @param res
* @param ctx
- * @return
*/
private def mkItem(intentMatch: NCIntentMatch, res: Option[NCResult], ctx: NCContext): NCDialogFlowItem =
new NCDialogFlowItem:
@@ -74,7 +73,6 @@ class NCDialogFlowManager(cfg: NCModelConfig) extends LazyLogging:
/**
*
- * @return
*/
def start(): Unit =
gc = NCUtils.mkThread("dialog-mgr-gc", cfg.getId) { t =>
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineHelper.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineHelper.java
index 40df4efc..ab54431e 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineHelper.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineHelper.java
@@ -58,7 +58,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
/**
*
- * @return
*/
private List<Long> computeLocal() {
List<Long> res = new ArrayList<>();
@@ -88,7 +87,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
/**
*
- * @return
*/
private List<Long> forkJoin() {
long mid = lo + hi >>> 1L;
@@ -105,7 +103,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
*
* @param l1
* @param l2
- * @return
*/
private static List<Long> merge(List<Long> l1, List<Long> l2) {
if (l1.isEmpty())
@@ -154,7 +151,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
*
* @param bits
* @param allBits
- * @return
*/
private static boolean excludes(long bits, List<Long> allBits) {
for (Long allBit : allBits)
@@ -168,7 +164,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
*
* @param bitSet1
* @param bitSet2
- * @return
*/
private static boolean containsAllBits(long bitSet1, long bitSet2) {
return (bitSet1 & bitSet2) == bitSet2;
@@ -179,7 +174,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
* @param words
* @param dict
* @param <T>
- * @return
*/
private static <T> long wordsToBits(Set<T> words, List<T> dict) {
long bits = 0;
@@ -196,7 +190,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
* @param bits
* @param dict
* @param <T>
- * @return
*/
private static <T> List<T> bitsToWords(long bits, List<T> dict) {
List<T> words = new ArrayList<>(Long.bitCount(bits));
@@ -210,7 +203,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
/**
*
- * @return
*/
@Override
protected List<Long> compute() {
@@ -222,7 +214,6 @@ class NCModelPipelineHelper extends RecursiveTask<List<Long>> {
* @param words
* @param pool
* @param <T>
- * @return
*/
static <T> List<List<T>> findCombinations(List<Set<T>> words, ForkJoinPool pool) {
assert words != null && !words.isEmpty();
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineManager.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineManager.scala
index 203e63c9..8d5c522a 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineManager.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelPipelineManager.scala
@@ -77,14 +77,12 @@ class NCModelPipelineManager(cfg: NCModelConfig, pipeline: NCPipeline) extends L
*
* @param list
* @tparam T
- * @return
*/
private def nvl[T](list: List[T]): Seq[T] = if list == null then List.empty else list
/**
*
* @param m
- * @return
*/
private def mkProps(m: NCPropertyMap): String =
if m.keysSet.isEmpty then ""
@@ -95,7 +93,6 @@ class NCModelPipelineManager(cfg: NCModelConfig, pipeline: NCPipeline) extends L
* @param txt
* @param data
* @param usrId
- * @return
*/
def prepare(txt: String, data: Map[String, Any], usrId: String): NCPipelineData =
require(txt != null && usrId != null)
@@ -103,7 +100,6 @@ class NCModelPipelineManager(cfg: NCModelConfig, pipeline: NCPipeline) extends L
/**
*
* @param ents
- * @return
*/
def newVariant(ents: List[NCEntity]): NCVariant =
new NCVariant:
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelScanner.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelScanner.scala
index ecc50fd4..ce3bd9f7 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelScanner.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/impl/NCModelScanner.scala
@@ -86,14 +86,12 @@ object NCModelScanner extends LazyLogging:
/**
*
* @param iter
- * @return
*/
private def col2Str(iter: Iterable[_]): String = iter.mkString("(", ",", ")")
/**
*
* @param clazz
- * @return
*/
private def class2Str(clazz: Class[_]): String =
val cls = clazz.getSimpleName.strip
@@ -103,7 +101,6 @@ object NCModelScanner extends LazyLogging:
/**
*
* @param mtd
- * @return
*/
private def method2Str(mtd: Method): String =
val cls = class2Str(mtd.getDeclaringClass)
@@ -114,7 +111,6 @@ object NCModelScanner extends LazyLogging:
/**
*
* @param f
- * @return
*/
private def field2Str(f: Field): String =
val cls = class2Str(f.getDeclaringClass)
@@ -127,7 +123,6 @@ object NCModelScanner extends LazyLogging:
* @param mtd
* @param prmClss
* @param argsList
- * @return
*/
private def prepareParams(cfg: NCModelConfig, mtd: Method, prmClss: List[Class[_]], argsList: List[List[NCEntity]]): Seq[AnyRef] =
prmClss.zip(argsList).zipWithIndex.map { case ((paramCls, argList), i) =>
@@ -164,7 +159,6 @@ object NCModelScanner extends LazyLogging:
* @param mtd
* @param obj
* @param args
- * @return
*/
private def invoke(cfg: NCModelConfig, mtd: Method, obj: AnyRef, args: scala.Array[AnyRef]): NCResult =
val methodObj = if Modifier.isStatic(mtd.getModifiers) then null else obj
@@ -195,7 +189,6 @@ object NCModelScanner extends LazyLogging:
* @param cfg
* @param field
* @param obj
- * @return
*/
private def getFieldObject(cfg: NCModelConfig, field: Field, obj: AnyRef): AnyRef =
lazy val fStr = field2Str(field)
@@ -339,7 +332,6 @@ object NCModelScanner extends LazyLogging:
* @param method
* @param obj
* @param intent
- * @return
*/
private def prepareCallback(cfg: NCModelConfig, method: Method, obj: AnyRef, intent: NCIDLIntent): NCCallbackInput => NCResult =
lazy val z = s"mdlId=${cfg.getId}, intentId=${intent.id}, type=${class2Str(method.getReturnType)}, callback=${method2Str(method)}"
@@ -406,7 +398,6 @@ object NCModelScanner extends LazyLogging:
/**
*
- * @return
*/
def scan(mdl: NCModel): Seq[NCModelIntent] =
require(mdl != null)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/NCIDLTerm.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/NCIDLTerm.scala
index ffd7a3ee..89e0bb87 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/NCIDLTerm.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/NCIDLTerm.scala
@@ -47,7 +47,6 @@ case class NCIDLTerm(
/**
*
* @param meta
- * @return
*/
def cloneWithFragMeta(meta: Map[String, Any]): NCIDLTerm =
NCIDLTerm(
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCodeGenerator.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCodeGenerator.scala
index cfc3352f..94aa7038 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCodeGenerator.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCodeGenerator.scala
@@ -47,7 +47,6 @@ trait NCIDLCodeGenerator:
*
* @param errMsg
* @param ctx
- * @return
*/
def newSyntaxError(errMsg: String)(implicit ctx: PRC): NCException =
val tok = ctx.start
@@ -58,7 +57,6 @@ trait NCIDLCodeGenerator:
* @param errMsg
* @param cause
* @param ctx
- * @return
*/
def newRuntimeError(errMsg: String, cause: Exception = null)(implicit ctx: PRC): NCException =
val tok = ctx.start
@@ -68,7 +66,6 @@ trait NCIDLCodeGenerator:
* Check if given object is mathematically an integer number.
*
* @param v
- * @return
*/
def isInt(v: Object): Boolean =
v.isInstanceOf[JLong] || v.isInstanceOf[JInt] || v.isInstanceOf[JByte] || v.isInstanceOf[JShort]
@@ -77,14 +74,12 @@ trait NCIDLCodeGenerator:
* Check if given object is mathematically an real number.
*
* @param v
- * @return
*/
def isReal(v: Object): Boolean = v.isInstanceOf[JDouble] || v.isInstanceOf[JFloat]
/**
*
* @param v
- * @return
*/
def asInt(v: Object): JLong = v match
case l: JLong => l
@@ -96,7 +91,6 @@ trait NCIDLCodeGenerator:
/**
*
* @param v
- * @return
*/
def asReal(v: Object): JDouble = v match
case l: JLong => l.doubleValue()
@@ -110,7 +104,6 @@ trait NCIDLCodeGenerator:
/**
*
* @param v
- * @return
*/
def box(v: Object): Object =
if v == null then null
@@ -164,7 +157,6 @@ trait NCIDLCodeGenerator:
/**
*
* @param stack
- * @return
*/
def pop1()(implicit stack: S, ctx: PRC): ST =
require(stack.nonEmpty, ctx.getText)
@@ -173,7 +165,6 @@ trait NCIDLCodeGenerator:
/**
*
* @param stack
- * @return
*/
def pop2()(implicit stack: S, ctx: PRC): (ST, ST) =
require(stack.size >= 2, ctx.getText)
@@ -187,7 +178,6 @@ trait NCIDLCodeGenerator:
/**
*
* @param stack
- * @return
*/
def pop3()(implicit stack: S, ctx: PRC): (ST, ST, ST) =
require(stack.size >= 3, ctx.getText)
@@ -203,7 +193,6 @@ trait NCIDLCodeGenerator:
*
* @param x1
* @param x2
- * @return
*/
def extract2(x1: ST, x2: ST): (Object, Object, Int) =
val Z(v1, n1) = x1()
@@ -216,7 +205,6 @@ trait NCIDLCodeGenerator:
* @param x1
* @param x2
* @param x3
- * @return
*/
def extract3(x1: ST, x2: ST, x3: ST): (Object, Object, Object, Int) =
val Z(v1, n1) = x1()
@@ -337,7 +325,6 @@ trait NCIDLCodeGenerator:
*
* @param and
* @param or
- * @return
*/
def parseAndOrExpr(and: TN, or: TN)(implicit ctx: PRC): SI = (_, stack: S, _) => {
val (x1, x2) = pop2()(stack, ctx)
@@ -360,7 +347,6 @@ trait NCIDLCodeGenerator:
*
* @param eq
* @param neq
- * @return
*/
def parseEqNeqExpr(eq: TN, neq: TN)(implicit ctx: PRC): SI = (_, stack: S, _) => {
val (x1, x2) = pop2()(stack, ctx)
@@ -432,7 +418,6 @@ trait NCIDLCodeGenerator:
/**
* @param minus
* @param not
- * @return
*/
def parseUnaryExpr(minus: TN, not: TN)(implicit ctx: PRC): SI = (_, stack: S, _) => {
val x = pop1()(stack, ctx)
@@ -459,7 +444,6 @@ trait NCIDLCodeGenerator:
/**
*
* @param txt
- * @return
*/
def parseAtom(txt: String)(implicit ctx: PRC): SI = {
val atom =
@@ -484,7 +468,6 @@ trait NCIDLCodeGenerator:
*
* @param fun
* @param ctx
- * @return
*/
def parseCallExpr(fun: String)(implicit ctx: PRC): SI = (ent: NCIDLEntity, stack: S, idlCtx) =>
implicit val evidence: S = stack
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCompiler.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCompiler.scala
index d8f4cba6..c939889a 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCompiler.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/compiler/NCIDLCompiler.scala
@@ -3,7 +3,7 @@
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliaNCException with
+ * (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
@@ -93,7 +93,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
/**
*
- * @return
*/
def getCompiledIntents: Set[NCIDLIntent] = intents.toSet
@@ -101,7 +100,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
*
* @param json
* @param ctx
- * @return
*/
private def json2Obj(json: String)(ctx: ParserRuleContext): Map[String, Object] =
try NCUtils.jsonToScalaMap(json)
@@ -247,7 +245,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
* @param subj
* @param check
* @param ctx
- * @return
*/
private def exprToFunction(subj: String, check: Object => Boolean)(implicit ctx: PRC): NCIDLFunction =
val code = mutable.Buffer.empty[SI]
@@ -360,7 +357,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
* @param idl
* @param origin IDL origin.
* @param mdlCfg
- * @return
*/
private def mkSyntaxError(
msg: String,
@@ -380,7 +376,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
* @param idl
* @param origin IDL origin.
* @param mdlCfg
- * @return
*/
private def mkRuntimeError(
msg: String,
@@ -401,7 +396,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
* @param idl
* @param origin IDL origin.
* @param mdlCfg
- * @return
*/
private def mkError(
kind: String,
@@ -464,7 +458,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
* @param idl
* @param origin
* @param isMethodLevel
- * @return
*/
private def antlr4Armature(idl: String, origin: String, isMethodLevel: Boolean): (FiniteStateMachine, IDP) =
val lexer = new NCIDLLexer(CharStreams.fromString(idl, origin))
@@ -486,7 +479,6 @@ class NCIDLCompiler(cfg: NCModelConfig) extends LazyLogging with mutable.Cloneab
* @param idl Intent IDL to compile.
* @param origin Optional source name.
* @param isMethodLevel Flag.
- * @return
*/
@throws[NCException]
def compile(idl: String, origin: String, isMethodLevel: Boolean = false): Set[NCIDLIntent] =
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/matcher/NCIntentSolverManager.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/matcher/NCIntentSolverManager.scala
index bc7877ef..b41a302f 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/matcher/NCIntentSolverManager.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/intent/matcher/NCIntentSolverManager.scala
@@ -111,7 +111,6 @@ object NCIntentSolverManager:
* Adds given weight to this weight.
*
* @param that Weight to add.
- * @return
*/
@targetName("plusEqual")
def +=(that: Weight): Weight =
@@ -126,7 +125,6 @@ object NCIntentSolverManager:
* Appends new weight.
*
* @param w New weight to append.
- * @return
*/
def append(w: Int): Weight =
buf.append(w)
@@ -136,7 +134,6 @@ object NCIntentSolverManager:
* Prepends new weight.
*
* @param w New weight to prepend.
- * @return
*/
def prepend(w: Int): Weight =
buf.prepend(w)
@@ -156,14 +153,12 @@ object NCIntentSolverManager:
*
* @param i Index in collection.
* @param c Collection.
- * @return
*/
private def norm(i: Int, c: mutable.ArrayBuffer[Int]): Int = if i < c.size then c(i) else 0
/**
*
* @param that
- * @return
*/
override def compare(that: Weight): Int =
def compareWeight(idx: Int): Option[Int] =
@@ -269,7 +264,6 @@ class NCIntentSolverManager(
* @param mdl Model.
* @param ctx Query context.
* @param intents Intents to match for.
- * @return
*/
private def solveIntents(mdl: NCModel, ctx: NCContext, intents: Map[NCIDLIntent, NCCallbackInput => NCResult]): List[IntentSolverResult] =
dialog.ack(ctx.getRequest.getUserId)
@@ -415,7 +409,6 @@ class NCIntentSolverManager(
* @param intent
* @param senEnts
* @param convEnts
- * @return
*/
private def solveIntent(
ctx: NCContext, intent: NCIDLIntent, senEnts: Seq[IntentEntity], convEnts: Seq[IntentEntity], varIdx: Int
@@ -555,7 +548,6 @@ class NCIntentSolverManager(
* @param idlCtx
* @param convEnts
* @param senEnts
- * @return
*/
private def solveTerm(
term: NCIDLTerm,
@@ -596,7 +588,6 @@ class NCIntentSolverManager(
* @param idlCtx
* @param senEnts
* @param convEnts
- * @return
*/
private def solvePredicate(
term: NCIDLTerm,
@@ -658,7 +649,6 @@ class NCIntentSolverManager(
* @param ctx
* @param typ
* @param key
- * @return
*/
private def solveIteration(mdl: NCModel, ctx: NCContext, typ: NCIntentSolveType, key: UserModelKey): Option[IterationResult] =
require(intents.nonEmpty)
@@ -763,7 +753,6 @@ class NCIntentSolverManager(
* @param mdl
* @param ctx
* @param typ
- * @return
*/
def solve(mdl: NCModel, ctx: NCContext, typ: NCIntentSolveType): ResultData =
import NCIntentSolveType.REGULAR
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroCompiler.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroCompiler.scala
index fe3194b2..a1f6b0ed 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroCompiler.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroCompiler.scala
@@ -61,7 +61,6 @@ object NCMacroCompiler extends LazyLogging:
*
* @param optS
* @param s
- * @return
*/
private def concat(optS: String, s: String): String = if optS.isEmpty then s else s"$optS $s"
@@ -69,7 +68,6 @@ object NCMacroCompiler extends LazyLogging:
*
* @param errMsg
* @param ctx
- * @return
*/
private def compilerError(errMsg: String)(implicit ctx: ParserRuleContext): NCException =
val tok = ctx.stop
@@ -166,7 +164,6 @@ object NCMacroCompiler extends LazyLogging:
/**
*
- * @return
*/
def getExpandedMacro: Set[String] =
require(expandedSyns != null)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroParser.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroParser.scala
index 040e7a69..396bb033 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroParser.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/makro/NCMacroParser.scala
@@ -83,14 +83,12 @@ class NCMacroParser:
* Trims all duplicate spaces.
*
* @param s
- * @return
*/
private def trimDupSpaces(s: String) = NCUtils.splitTrimFilter(s, " ").mkString(" ")
/**
*
* @param s
- * @return
*/
private def processEscapes(s: String): String =
val len = s.length()
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCResourceReader.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCResourceReader.scala
index 531be528..68c245c9 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCResourceReader.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCResourceReader.scala
@@ -41,7 +41,6 @@ object NCResourceReader extends LazyLogging:
/**
*
* @param dir
- * @return
*/
private def mkDir(dir: String): File =
val normDir = if dir != null then dir else DFLT_DIR
@@ -55,7 +54,6 @@ object NCResourceReader extends LazyLogging:
/**
*
* @param url
- * @return
*/
private def readMd5(url: String): Map[Path, String] =
try
@@ -86,7 +84,6 @@ object NCResourceReader extends LazyLogging:
*
* @param f
* @param md5
- * @return
*/
private def getMd5(f: File, md5: Map[Path, String]): String =
val path = Path.of(f.getAbsolutePath)
@@ -102,7 +99,6 @@ object NCResourceReader extends LazyLogging:
*
* @param f
* @param md5
- * @return
*/
private def isValid(f: File, md5: Map[Path, String]): Boolean =
val v1 = getMd5(f, md5)
@@ -125,7 +121,6 @@ object NCResourceReader extends LazyLogging:
* @param path
* @param outFile
* @param md5
- * @return
*/
private def download(path: String, outFile: String, md5: Map[Path, String]): File =
mkDir(new File(outFile).getParent)
@@ -144,7 +139,6 @@ object NCResourceReader extends LazyLogging:
/**
*
* @param path
- * @return
*/
def get(path: String): File =
val md5 = readMd5(MD5_FILE_URL)
@@ -186,6 +180,5 @@ object NCResourceReader extends LazyLogging:
/**
*
* @param path
- * @return
*/
def getPath(path: String): String = get(path).getAbsolutePath
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCUtils.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCUtils.scala
index c19e626a..5bdd9713 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCUtils.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/internal/util/NCUtils.scala
@@ -58,7 +58,6 @@ object NCUtils extends LazyLogging:
* Tests whether given system property of environment variable is set or not.
*
* @param s @param s Name of the system property or environment variable.
- * @return
*/
def isSysEnvSet(s: String): Boolean = sysProps.get(s).nonEmpty || sys.env.contains(s)
@@ -112,7 +111,6 @@ object NCUtils extends LazyLogging:
/**
*
* @param json
- * @return
*/
def prettyJson(json: String): String =
if json == null || json.isEmpty then ""
@@ -128,7 +126,6 @@ object NCUtils extends LazyLogging:
/**
*
* @param json
- * @return
*/
def isValidJson(json: String): Boolean =
scala.util.Try(GSON.getAdapter(classOf[JsonElement]).fromJson(json)).isSuccess
@@ -137,7 +134,6 @@ object NCUtils extends LazyLogging:
*
* @param json
* @param field
- * @return
*/
@throws[Exception]
def getJsonStringField(json: String, field: String): String =
@@ -147,7 +143,6 @@ object NCUtils extends LazyLogging:
*
* @param json
* @param field
- * @return
*/
@throws[Exception]
def getJsonIntField(json: String, field: String): Int =
@@ -157,7 +152,6 @@ object NCUtils extends LazyLogging:
*
* @param json
* @tparam T
- * @return
*/
def jsonToObject[T](json: String, typ: java.lang.reflect.Type): T =
GSON.fromJson(json, typ)
@@ -166,7 +160,6 @@ object NCUtils extends LazyLogging:
*
* @param json
* @tparam T
- * @return
*/
def jsonToObject[T](json: String, cls: Class[T]): T =
GSON.fromJson(json, cls)
@@ -175,7 +168,6 @@ object NCUtils extends LazyLogging:
* Shortcut to convert given JSON to Scala map with default mapping.
*
* @param json JSON to convert.
- * @return
*/
@throws[Exception]
def jsonToScalaMap(json: String): Map[String, Object] =
@@ -185,7 +177,6 @@ object NCUtils extends LazyLogging:
* Shortcut to convert given JSON to Java map with default mapping.
*
* @param json JSON to convert.
- * @return
*/
def jsonToJavaMap(json: String): java.util.Map[String, Object] =
try GSON.fromJson(json, classOf[java.util.HashMap[String, Object]])
@@ -195,7 +186,6 @@ object NCUtils extends LazyLogging:
*
* @param json
* @param field
- * @return
*/
def getJsonBooleanField(json: String, field: String): Boolean =
try GSON.getAdapter(classOf[JsonElement]).fromJson(json).getAsJsonObject.get(field).getAsBoolean
@@ -221,7 +211,6 @@ object NCUtils extends LazyLogging:
* @param v
* @param dflt
* @tparam T
- * @return
*/
def notNull[T <: AnyRef](v: T, dflt: T): T = if v == null then dflt else v
@@ -229,7 +218,6 @@ object NCUtils extends LazyLogging:
* Trims each sequence string and filters out empty ones.
*
* @param s String to process.
- * @return
*/
def trimFilter(s: Seq[String]): Seq[String] =
s.map(_.strip).filter(_.nonEmpty)
@@ -239,7 +227,6 @@ object NCUtils extends LazyLogging:
*
* @param s String to split.
* @param sep Separator (regex) to split by.
- * @return
*/
def splitTrimFilter(s: String, sep: String): Seq[String] =
trimFilter(s.split(sep).toIndexedSeq)
@@ -248,7 +235,6 @@ object NCUtils extends LazyLogging:
* Recursively removes quotes from given string.
*
* @param s
- * @return
*/
@tailrec
def trimQuotes(s: String): String =
@@ -262,7 +248,6 @@ object NCUtils extends LazyLogging:
* Recursively removes quotes and replaces escaped quotes from given string.
*
* @param s
- * @return
*/
@tailrec
def trimEscapesQuotes(s: String): String =
@@ -281,7 +266,6 @@ object NCUtils extends LazyLogging:
* Recursively removes quotes and replaces escaped quotes from given string.
*
* @param s
- * @return
*/
@tailrec
def escapesQuotes(s: String): String =
@@ -299,7 +283,6 @@ object NCUtils extends LazyLogging:
*
* @param s
* @param sep
- * @return
*/
def normalize(s: String, sep: String): String =
splitTrimFilter(s, sep).mkString(sep)
@@ -367,7 +350,6 @@ object NCUtils extends LazyLogging:
* @param prefix
* @param mdlId
* @param body
- * @return
*/
def mkThread(prefix: String, mdlId: String)(body: Thread => Unit): Thread = mkThread(s"$prefix-@$mdlId")(body)
@@ -381,7 +363,6 @@ object NCUtils extends LazyLogging:
/**
*
* @param url URL to check.
- * @return
*/
def isUrl(url: String): Boolean =
try
@@ -393,7 +374,6 @@ object NCUtils extends LazyLogging:
/**
*
* @param path Local file path to check.
- * @return
*/
def isFile(path: String): Boolean =
val f = new File(path)
@@ -402,7 +382,6 @@ object NCUtils extends LazyLogging:
/**
*
* @param f
- * @return
*/
def isFile(f: File): Boolean = f.exists() && f.isFile
@@ -468,7 +447,6 @@ object NCUtils extends LazyLogging:
*
* @param seq Sequence to check for dups from.
* @tparam T
- * @return
* @see #containsDups
*/
def getDups[T](seq: Seq[T]): Set[T] = seq.diff(seq.distinct).toSet
@@ -532,14 +510,12 @@ object NCUtils extends LazyLogging:
/**
*
* @param s
- * @return
*/
def decapitalize(s: String): String = s"${s.head.toLower}${s.tail}"
/**
*
* @param s
- * @return
*/
def capitalize(s: String): String = s"${s.head.toUpper}${s.tail}"
@@ -738,7 +714,6 @@ object NCUtils extends LazyLogging:
/**
*
* @param in
- * @return
*/
private def readLcTrimFilter(in: BufferedSource): List[String] =
in.getLines().map(_.toLowerCase.strip).filter(s => s.nonEmpty && s.head!= '#').toList
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCOpenNLPEntityParser.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCOpenNLPEntityParser.scala
index 64bc8137..e70724bb 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCOpenNLPEntityParser.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCOpenNLPEntityParser.scala
@@ -69,7 +69,6 @@ class NCOpenNLPEntityParser(srcs: List[String]) extends NCEntityParser with Lazy
*
* @param finder
* @param words
- * @return
*/
private def find(finder: NameFinderME, words: Array[String]): Array[Holder] = finder.synchronized {
try finder.find(words).map(p => Holder(p.getStart, p.getEnd - 1, p.getType, p.getProb))
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticElement.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticElement.scala
index 6341beed..920cc53b 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticElement.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticElement.scala
@@ -36,30 +36,25 @@ package org.apache.nlpcraft.nlp.parsers
trait NCSemanticElement:
/**
*
- * @return
*/
def getId: String
/**
*
- * @return
*/
def getGroups: Set[String] = Set(getId)
/**
*
- * @return
*/
def getValues: Map[String, Set[String]] = Map.empty
/**
*
- * @return
*/
def getSynonyms: Set[String] = Set.empty
/**
*
- * @return
*/
def getProperties: Map[String, AnyRef] = Map.empty
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.scala
index 17952800..c5f959b6 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticEntityParser.scala
@@ -41,7 +41,6 @@ object NCSemanticEntityParser:
* @param parser
* @param macros
* @param elements
- * @return
*/
def apply(
stemmer: NCSemanticStemmer,
@@ -61,7 +60,6 @@ object NCSemanticEntityParser:
* @param stemmer
* @param parser
* @param elements
- * @return
*/
def apply(
stemmer: NCSemanticStemmer,
@@ -79,7 +77,6 @@ object NCSemanticEntityParser:
* @param stemmer
* @param parser
* @param mdlSrc
- * @return
*/
def apply(stemmer: NCSemanticStemmer, parser: NCTokenParser, mdlSrc: String): NCSemanticEntityParser =
require(stemmer != null, "Stemmer cannot be null.")
@@ -97,7 +94,6 @@ object NCSemanticEntityParser:
/**
*
* @param t
- * @return
*/
private def isStopWord(t: NCToken): Boolean = t.get[Boolean]("stopword").getOrElse(false)
@@ -165,7 +161,6 @@ object NCSemanticEntityParser:
* @param data2
* @param i
* @param tmp
- * @return
*/
@tailrec private def combine(data1: Seq[String], data2: Seq[String], i: Int = 0, tmp: Set[List[String]] = Set(List.empty)): Set[List[String]] =
require(data1.size == data2.size)
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticStemmer.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticStemmer.scala
index e08f4845..84a6265f 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticStemmer.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/NCSemanticStemmer.scala
@@ -37,6 +37,5 @@ trait NCSemanticStemmer:
/**
*
* @param txt
- * @return
*/
def stem(txt: String): String
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSourceReader.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSourceReader.scala
index 4a35e3d2..c9a2cfd5 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSourceReader.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSourceReader.scala
@@ -84,7 +84,6 @@ private[parsers] object NCSemanticSourceReader:
*
* @param is
* @param typ
- * @return
*/
def read(is: InputStream, typ: NCSemanticSourceType): NCSemanticSourceData =
val mapper =
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSynonymsProcessor.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSynonymsProcessor.scala
index 1408fa87..002c1f0b 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSynonymsProcessor.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/parsers/impl/NCSemanticSynonymsProcessor.scala
@@ -61,7 +61,6 @@ private[parsers] object NCSemanticSynonymsProcessor extends LazyLogging:
/**
*
* @param iter
- * @return
*/
private def hasNullOrEmpty(iter: Iterable[String]): Boolean = iter.exists(p => p == null || p.strip.isEmpty)
@@ -143,7 +142,6 @@ private[parsers] object NCSemanticSynonymsProcessor extends LazyLogging:
* @param macroParser
* @param elemId
* @param syns
- * @return
*/
private def convertSynonyms(
stemmer: NCSemanticStemmer,
@@ -205,7 +203,6 @@ private[parsers] object NCSemanticSynonymsProcessor extends LazyLogging:
* @param tokParser
* @param macros
* @param elements
- * @return
*/
def prepare(
stemmer: NCSemanticStemmer,
diff --git a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelCallbacksSpec.scala b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelCallbacksSpec.scala
index 52c725fa..938fa56a 100644
--- a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelCallbacksSpec.scala
+++ b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelCallbacksSpec.scala
@@ -66,7 +66,6 @@ class NCModelCallbacksSpec extends AnyFunSuite:
/**
*
* @param s
- * @return
*/
private def has(s: State): Boolean = states.synchronized { states.contains(s) }
@@ -76,14 +75,12 @@ class NCModelCallbacksSpec extends AnyFunSuite:
* @param v
* @param dtlt
* @tparam T
- * @return
*/
private def getOrElse[T](s: State, v: T, dtlt: => T): T = if has(s) then v else dtlt
/**
*
* @param states
- * @return
*/
private def set(states: State*) = this.states.synchronized {
this.states.clear()
diff --git a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelClientSpec.scala b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelClientSpec.scala
index e44ee36e..ddbb5ebf 100644
--- a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelClientSpec.scala
+++ b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/NCModelClientSpec.scala
@@ -32,7 +32,6 @@ class NCModelClientSpec extends AnyFunSuite:
/**
*
* @param e
- * @return
*/
private def s(e: NCEntity): String =
s"Entity [id=${e.getId}, text=${e.mkText}, properties={${e.keysSet.map(k => s"$k=${e(k)}")}}]"
diff --git a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/scan/NCTestModelScala.scala b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/scan/NCTestModelScala.scala
index 789b02ea..61e4f29a 100644
--- a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/scan/NCTestModelScala.scala
+++ b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/impl/scan/NCTestModelScala.scala
@@ -66,7 +66,6 @@ object NCTestModelScala:
/**
*
- * @return
*/
def mkModel: NCModel = new NCTestModelAdapter() :
@NCIntent("intent=locInt term(single)~{# == 'id1'} term(list)~{# == 'id2'}[0,10] term(opt)~{# == 'id3'}?")
diff --git a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/intent/compiler/functions/NCIDLFunctions.scala b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/intent/compiler/functions/NCIDLFunctions.scala
index dd0edb17..09ab5b7a 100644
--- a/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/intent/compiler/functions/NCIDLFunctions.scala
+++ b/nlpcraft/src/test/scala/org/apache/nlpcraft/internal/intent/compiler/functions/NCIDLFunctions.scala
@@ -65,7 +65,6 @@ private[functions] object NCIDLFunctions:
/**
*
* @param truth
- * @return
*/
def apply(truth: String): TestDesc =
new TestDesc(truth = truth, idlCtx = mkIdlContext())
@@ -75,7 +74,6 @@ private[functions] object NCIDLFunctions:
* @param truth
* @param entity
* @param idlCtx
- * @return
*/
def apply(truth: String, entity: NCEntity, idlCtx: NCIDLContext): TestDesc =
new TestDesc(truth = truth, entity = Option(entity), idlCtx = idlCtx)
@@ -84,7 +82,6 @@ private[functions] object NCIDLFunctions:
*
* @param truth
* @param entity
- * @return
*/
def apply(truth: String, entity: NCEntity): TestDesc =
new TestDesc(truth = truth, entity = Option(entity), idlCtx = mkIdlContext(entities = Seq(entity)))
@@ -95,7 +92,6 @@ private[functions] object NCIDLFunctions:
/**
*
* @param e
- * @return
*/
private def e2s(e: NCEntity): String = s"${e.getId} (${e.getTokens.map(_.getText).mkString(" ")})"
@@ -111,7 +107,6 @@ private[functions] object NCIDLFunctions:
* @param intentMeta
* @param convMeta
* @param fragMeta
- * @return
*/
def mkIdlContext(
entities: Seq[NCEntity] = Seq.empty,
@@ -142,7 +137,6 @@ private[functions] object NCIDLFunctions:
* @param groups
* @param meta
* @param tokens
- * @return
*/
def mkEntity(
id: String = UUID.randomUUID().toString,
diff --git a/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestRequest.scala b/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestRequest.scala
index 31092255..a212f3ef 100644
--- a/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestRequest.scala
+++ b/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestRequest.scala
@@ -51,6 +51,5 @@ object NCTestRequest:
/**
*
* @param txt
- * @return
*/
def apply(txt: String): NCTestRequest = new NCTestRequest(txt)
\ No newline at end of file
diff --git a/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestUtils.scala b/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestUtils.scala
index 64b9dbaa..fd1e0b07 100644
--- a/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestUtils.scala
+++ b/nlpcraft/src/test/scala/org/apache/nlpcraft/nlp/util/NCTestUtils.scala
@@ -35,7 +35,6 @@ object NCTestUtils:
/**
*
* @param m
- * @return
*/
private def mkProps(m: NCPropertyMap): String =
m.keysSet.toSeq.sorted.map(p => s"$p=${m[Any](p)}").mkString("{", ", ", "}")
@@ -122,7 +121,6 @@ object NCTestUtils:
/**
*
- * @return
*/
private def mkSemanticStemmer: NCSemanticStemmer =
new NCSemanticStemmer():
@@ -134,7 +132,6 @@ object NCTestUtils:
*
* @param elms
* @param macros
- * @return
*/
def mkEnSemanticParser(elms: List[NCSemanticElement], macros: Map[String, String] = Map.empty): NCSemanticEntityParser =
parsers.NCSemanticEntityParser(mkSemanticStemmer, EN_TOK_PARSER, macros, elms)
@@ -142,7 +139,6 @@ object NCTestUtils:
/**
*
* @param elms
- * @return
*/
def mkEnSemanticParser(elms: NCSemanticElement*): NCSemanticEntityParser =
parsers.NCSemanticEntityParser(mkSemanticStemmer, EN_TOK_PARSER, elms.toList)
@@ -150,7 +146,6 @@ object NCTestUtils:
/**
*
* @param mdlSrc
- * @return
*/
def mkEnSemanticParser(mdlSrc: String): NCSemanticEntityParser =
parsers.NCSemanticEntityParser(mkSemanticStemmer, EN_TOK_PARSER, mdlSrc)
\ No newline at end of file