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 03a4946b Update docroot.md
new e316645b Merge branch 'master' of
https://github.com/apache/incubator-nlpcraft
03a4946b is described below
commit 03a4946b14c645f3f0b2fd44051b0396e6273e46
Author: Aaron Radzinski <[email protected]>
AuthorDate: Tue Sep 6 11:55:19 2022 -0700
Update docroot.md
---
scaladoc/docroot.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/scaladoc/docroot.md b/scaladoc/docroot.md
index 72a8dab4..cf57e844 100644
--- a/scaladoc/docroot.md
+++ b/scaladoc/docroot.md
@@ -16,7 +16,7 @@ SCALA3 API TO CONVERT NATURAL LANGUAGE INTO ACTION
[](https://raw.githubusercontent.com/apache/opennlp/master/LICENSE)
[](https://search.maven.org/artifact/org.apache.nlpcraft/nlpcraft)
-Maven dependency:
+#### **Maven dependency:**
<pre>
<dependency>
<groupId>org.apache.nlpcraft</groupId>
@@ -25,7 +25,20 @@ Maven dependency:
</dependency>
</pre>
-SBT dependency:
+#### **SBT dependency:**
<pre>
libraryDependencies += "org.apache.nlpcraft" % "nlpcraft" % "1.0.0"
</pre>
+
+#### **Annotations:**
+Due to Scala 3 limitation on runtime retained annotations NLPCraft annotations
are written in Java. Javadoc documentation
+cannot be readily integrated into standard Scaladoc tooling chain and
therefore NLPCraft annotations are listed here
+along with their source code for the purpose of documentation:
+
+`org.apache.nlpcraft.annotations.`**NCIntent**
+
+`org.apache.nlpcraft.annotations.`**NCIntentRef**
+
+`org.apache.nlpcraft.annotations.`**NCIntentTerm**
+
+`org.apache.nlpcraft.annotations`.**NCIntentObject**