[incubator-nlpcraft] branch master updated: WIP Javadoc.

Wed, 23 Mar 2022 13:03:40 -0700 

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 899178e  WIP Javadoc.
899178e is described below

commit 899178e98a04b2d0e8bd18fbc406c898b43772ed
Author: Aaron Radzinski <aradzin...@datalingvo.com>
AuthorDate: Wed Mar 23 13:03:30 2022 -0700

    WIP Javadoc.
---
 nlpcraft/pom.xml                                   | 22 +++++++++++++++++++++-
 .../nlpcraft/nlp/entity/parser/package-info.java   | 21 +++++++++++++++++++++
 .../nlp/entity/parser/semantic/package-info.java   | 21 +++++++++++++++++++++
 .../nlpcraft/nlp/token/enricher/package-info.java  | 21 +++++++++++++++++++++
 .../nlpcraft/nlp/token/parser/package-info.java    | 21 +++++++++++++++++++++
 .../scala/org/apache/nlpcraft/package-info.java    | 21 +++++++++++++++++++++
 6 files changed, 126 insertions(+), 1 deletion(-)

diff --git a/nlpcraft/pom.xml b/nlpcraft/pom.xml
index 6ca48d4..05c8d3a 100644
--- a/nlpcraft/pom.xml
+++ b/nlpcraft/pom.xml
@@ -252,7 +252,7 @@
                 <configuration>
                     <additionalOptions>--allow-script-in-comments 
--ignore-source-errors</additionalOptions>
                     
<javadocDirectory>${project.basedir}/../javadoc</javadocDirectory>
-                    <doclint>all</doclint>
+                    <doclint>none</doclint>
                     <docfilessubdirs>true</docfilessubdirs>
                     <encoding>UTF-8</encoding>
                     <failOnError>false</failOnError>
@@ -286,6 +286,26 @@
                     <excludePackageNames>
                         
org.apache.nlpcraft.internal.*:org.apache.nlpcraft.nlp.token.impl.*:org.apache.nlpcraft.nlp.token.enricher.impl.*:org.apache.nlpcraft.nlp.token.parser.impl.*:org.apache.nlpcraft.nlp.entity.parser.impl.*
                     </excludePackageNames>
+                    <groups>
+                        <group>
+                            <title>Main API</title>
+                            <packages>
+                                org.apache.nlpcraft
+                            </packages>
+                        </group>
+                        <group>
+                            <title>Entities</title>
+                            <packages>
+                                
org.apache.nlpcraft.nlp.entity.parser:org.apache.nlpcraft.nlp.entity.parser.semantic
+                            </packages>
+                        </group>
+                        <group>
+                            <title>Tokens</title>
+                            <packages>
+                                
org.apache.nlpcraft.nlp.token.parser:org.apache.nlpcraft.nlp.token.enricher
+                            </packages>
+                        </group>
+                    </groups>
                     <header>
                         <![CDATA[
                             Apache NLPCraft <span style="font-size: 
80%">${project.version}</span>
diff --git 
a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/entity/parser/package-info.java
 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/entity/parser/package-info.java
new file mode 100644
index 0000000..905402e
--- /dev/null
+++ 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/entity/parser/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * 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 compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Contains built-in entity parsers.
+ */
+package org.apache.nlpcraft.nlp.entity.parser;
\ No newline at end of file
diff --git 
a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/entity/parser/semantic/package-info.java
 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/entity/parser/semantic/package-info.java
new file mode 100644
index 0000000..129c1f0
--- /dev/null
+++ 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/entity/parser/semantic/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * 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 compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Contains built-in semantic entity parsers.
+ */
+package org.apache.nlpcraft.nlp.entity.parser.semantic;
\ No newline at end of file
diff --git 
a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/token/enricher/package-info.java
 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/token/enricher/package-info.java
new file mode 100644
index 0000000..f6d2488
--- /dev/null
+++ 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/token/enricher/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * 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 compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Contains built-in token enrichers.
+ */
+package org.apache.nlpcraft.nlp.token.enricher;
\ No newline at end of file
diff --git 
a/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/token/parser/package-info.java
 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/token/parser/package-info.java
new file mode 100644
index 0000000..ae6bee9
--- /dev/null
+++ 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/nlp/token/parser/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * 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 compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Contains built-in token parsers.
+ */
+package org.apache.nlpcraft.nlp.token.parser;
\ No newline at end of file
diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/package-info.java 
b/nlpcraft/src/main/scala/org/apache/nlpcraft/package-info.java
new file mode 100644
index 0000000..981c531
--- /dev/null
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * 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 compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Contains <b>main API</b> for defining data models.
+ */
+package org.apache.nlpcraft;
\ No newline at end of file

Reply via email to