You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by li...@apache.org on 2022/09/16 17:35:41 UTC
[arrow-adbc] branch main updated: docs(java): configure Javadocs (#128)
This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-adbc.git
The following commit(s) were added to refs/heads/main by this push:
new a520966 docs(java): configure Javadocs (#128)
a520966 is described below
commit a520966b70122f9d1c48e6fd142c5fe29708fde5
Author: David Li <li...@gmail.com>
AuthorDate: Fri Sep 16 13:35:36 2022 -0400
docs(java): configure Javadocs (#128)
---
.github/workflows/dev_pr/title_check.js | 2 +-
.../org/apache/arrow/adbc/core/AdbcConnection.java | 7 +++++
java/pom.xml | 35 ++++++++++++++++++++++
3 files changed, 43 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/dev_pr/title_check.js b/.github/workflows/dev_pr/title_check.js
index 7dda0cf..8de51d3 100644
--- a/.github/workflows/dev_pr/title_check.js
+++ b/.github/workflows/dev_pr/title_check.js
@@ -40,7 +40,7 @@ function matchesCommitFormat(title) {
return title.match(regexp) != null;
}
-async function commitCommitFormat(github, context, pullRequestNumber) {
+async function commentCommitFormat(github, context, pullRequestNumber) {
const {data: comments} = await github.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
diff --git a/java/core/src/main/java/org/apache/arrow/adbc/core/AdbcConnection.java b/java/core/src/main/java/org/apache/arrow/adbc/core/AdbcConnection.java
index 4f38c28..fea7054 100644
--- a/java/core/src/main/java/org/apache/arrow/adbc/core/AdbcConnection.java
+++ b/java/core/src/main/java/org/apache/arrow/adbc/core/AdbcConnection.java
@@ -99,6 +99,7 @@ public interface AdbcConnection extends AutoCloseable {
* <tr><th>Field Name</th> <th>Field Type</th> </tr>
* <tr><td>catalog_name</td> <td>utf8</td> </tr>
* <tr><td>catalog_db_schemas</td> <td>list[DB_SCHEMA_SCHEMA]</td> </tr>
+ * <caption>The definition of the GetObjects result schema.</caption>
* </table>
*
* DB_SCHEMA_SCHEMA is a Struct with fields:
@@ -107,6 +108,7 @@ public interface AdbcConnection extends AutoCloseable {
* <tr><th>Field Name</th> <th>Field Type</th> </tr>
* <tr><td>db_schema_name</td> <td>utf8</td> </tr>
* <tr><td>db_schema_tables</td> <td>list[TABLE_SCHEMA]</td> </tr>
+ * <caption>The definition of DB_SCHEMA_SCHEMA.</caption>
* </table>
*
* TABLE_SCHEMA is a Struct with fields:
@@ -117,6 +119,7 @@ public interface AdbcConnection extends AutoCloseable {
* <tr><td>table_type</td> <td>utf8 not null</td> </tr>
* <tr><td>table_columns</td> <td>list[COLUMN_SCHEMA]</td> </tr>
* <tr><td>table_constraints</td> <td>list[CONSTRAINT_SCHEMA]</td></tr>
+ * <caption>The definition of TABLE_SCHEMA.</caption>
* </table>
*
* COLUMN_SCHEMA is a Struct with fields:
@@ -142,6 +145,7 @@ public interface AdbcConnection extends AutoCloseable {
* <tr><td>xdbc_scope_table</td> <td>utf8</td> <td>(3)</td></tr>
* <tr><td>xdbc_is_autoincrement</td> <td>bool</td> <td>(3)</td></tr>
* <tr><td>xdbc_is_generatedcolumn</td> <td>bool</td> <td>(3)</td></tr>
+ * <caption>The definition of COLUMN_SCHEMA.</caption>
* </table>
*
* Notes:
@@ -161,6 +165,7 @@ public interface AdbcConnection extends AutoCloseable {
* <tr><td>constraint_type</td> <td>utf8 not null</td> <td>(1)</td></tr>
* <tr><td>constraint_column_names</td> <td>list[utf8] not null</td> <td>(2)</td></tr>
* <tr><td>constraint_column_usage</td> <td>list[USAGE_SCHEMA]</td> <td>(3)</td></tr>
+ * <caption>The definition of CONSTRAINT_SCHEMA.</caption>
* </table>
*
* <ol>
@@ -177,6 +182,7 @@ public interface AdbcConnection extends AutoCloseable {
* <tr><td>fk_db_schema</td> <td>utf8</td> </tr>
* <tr><td>fk_table</td> <td>utf8 not null</td> </tr>
* <tr><td>fk_column_name</td> <td>utf8 not null</td> </tr>
+ * <caption>The definition of USAGE_SCHEMA.</caption>
* </table>
*
* @param depth The level of nesting to display. If ALL, display all levels (up through columns).
@@ -249,6 +255,7 @@ public interface AdbcConnection extends AutoCloseable {
* <td>table_type</td>
* <td>utf8 not null</td>
* </tr>
+ * <caption>The definition of the result schema.</caption>
* </table>
*/
default ArrowReader getTableTypes() throws AdbcException {
diff --git a/java/pom.xml b/java/pom.xml
index 74dd26b..9383b2f 100644
--- a/java/pom.xml
+++ b/java/pom.xml
@@ -207,6 +207,41 @@
</plugins>
</build>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>3.4.1</version>
+ <configuration>
+ <!-- Stop it from trying to document the tests -->
+ <additionalOptions>-package</additionalOptions>
+ <!-- Ignore missing @return, @throws -->
+ <doclint>all,-missing</doclint>
+ <links>
+ <link>https://arrow.apache.org/docs/java/reference/</link>
+ </links>
+ <source>1.8</source>
+ </configuration>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <inherited>false</inherited>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ <reportSet>
+ <id>default</id>
+ <reports>
+ <report>javadoc</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+
<profiles>
<profile>
<id>jdk8</id>