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 2020/12/01 18:42:45 UTC

[incubator-nlpcraft] branch master updated: fix javadoc warning and fix build [https://issues.apache.org/jira/browse/NLPCRAFT-176]

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 5af49ec  fix javadoc warning and fix build [https://issues.apache.org/jira/browse/NLPCRAFT-176]
     new 1dda3ea  Merge pull request #10 from sreev/fix-javadoc
5af49ec is described below

commit 5af49ec7edc71d489799beedaa7ff4a361b1408d
Author: Sree Vaddi <44...@users.noreply.github.com>
AuthorDate: Sun Nov 22 18:35:41 2020 -0800

    fix javadoc warning and fix build [https://issues.apache.org/jira/browse/NLPCRAFT-176]
    
    Signed-off-by: Sree Vaddi <44...@users.noreply.github.com>
---
 .../src/main/scala/org/apache/nlpcraft/model/NCIntentTerm.java   | 5 +++++
 nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java  | 7 +++++++
 .../org/apache/nlpcraft/model/tools/sqlgen/NCSqlJoinType.java    | 9 +++++++++
 3 files changed, 21 insertions(+)

diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCIntentTerm.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCIntentTerm.java
index 85fbad1..774c4b0 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCIntentTerm.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCIntentTerm.java
@@ -44,5 +44,10 @@ import static java.lang.annotation.RetentionPolicy.*;
 @Retention(value=RUNTIME)
 @Target(value=PARAMETER)
 public @interface NCIntentTerm {
+    /**
+     * ID of the intent defined externally.
+     *
+     * @return ID of the intent defined externally.
+     */
     String value();
 }
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java
index 76bc257..db0cb9e 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/NCResult.java
@@ -55,9 +55,16 @@ import java.util.Collection;
  * accept {@code text} result type and ignore everything else.
  */
 public class NCResult implements Serializable {
+    /** Data Model result text. */
     private String body;
+
+    /** Data Model result type. One of text, html, json or yaml. */
     private String type;
+
+    /** Sequence of tokens represents a fully parsed (see {@link NCContext#getVariants()} method) user input. */
     private Collection<NCToken> tokens;
+
+    /** ID of the intent defined externally. */
     private String intentId;
     
     /**
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/sqlgen/NCSqlJoinType.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/sqlgen/NCSqlJoinType.java
index 63fa277..5067b29 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/sqlgen/NCSqlJoinType.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/sqlgen/NCSqlJoinType.java
@@ -32,10 +32,19 @@ package org.apache.nlpcraft.model.tools.sqlgen;
  *     - "customer_id"
  *     jointype: "left"
  * </pre>
+ *
+ * Refer to <a target=_ href="https://en.wikipedia.org/wiki/Join_(SQL)">SQL Join</a>.
  */
 public enum NCSqlJoinType {
+    /** The INNER JOIN keyword selects records that have matching values in both tables. */
     INNER,
+
+    /** The LEFT JOIN keyword returns all records from the left table, and the matched records from the right table. */
     LEFT,
+
+    /** The RIGHT JOIN keyword returns all records from the right table, and the matched records from the left table. */
     RIGHT,
+
+    /** The FULL OUTER JOIN keyword returns all records when there is a match in left or right table records. */
     OUTER
 }