You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by am...@apache.org on 2021/07/19 16:28:17 UTC
[ignite-3] 01/02: Fix javadoc styles.
This is an automated email from the ASF dual-hosted git repository.
amashenkov pushed a commit to branch ignite-15153
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
commit 26894f65f726d1b68a9a9424bbdb4dc88c480d1e
Author: Andrew Mashenkov <an...@gmail.com>
AuthorDate: Mon Jul 19 18:05:30 2021 +0300
Fix javadoc styles.
---
check-rules/checkstyle-disabled-modules.xml | 2 --
.../main/java/org/apache/ignite/internal/schema/package-info.java | 5 +++--
.../src/main/java/org/apache/ignite/schema/SchemaBuilders.java | 8 ++++++++
.../org/apache/ignite/{internal => }/schema/package-info.java | 5 ++---
.../src/main/java/org/apache/ignite/binary}/package-info.java | 5 ++---
5 files changed, 15 insertions(+), 10 deletions(-)
diff --git a/check-rules/checkstyle-disabled-modules.xml b/check-rules/checkstyle-disabled-modules.xml
index db720ea..637c29f 100644
--- a/check-rules/checkstyle-disabled-modules.xml
+++ b/check-rules/checkstyle-disabled-modules.xml
@@ -34,6 +34,4 @@
<suppress files="[/\\]modules/network-api[/\\]" checks=".*" />
<suppress files="[/\\]modules/rest[/\\]" checks=".*" />
<suppress files="[/\\]modules/runner[/\\]" checks=".*" />
- <suppress files="[/\\]modules/schema[/\\]" checks=".*" />
- <suppress files="[/\\]modules/table[/\\]" checks=".*" />
</suppressions>
diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
index 955effb..53eb792 100644
--- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
+++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
@@ -16,7 +16,8 @@
*/
/**
- * <!-- Package description. -->
- * Contains schema description, row assembly and field accessor classes.
+ * Contains internal classes for schema definition and row assembling,
+ * schema manipulation and schema history maintaning logic,
+ * user object marshallers.
*/
package org.apache.ignite.internal.schema;
\ No newline at end of file
diff --git a/modules/schema/src/main/java/org/apache/ignite/schema/SchemaBuilders.java b/modules/schema/src/main/java/org/apache/ignite/schema/SchemaBuilders.java
index ac2b646..fa806c0 100644
--- a/modules/schema/src/main/java/org/apache/ignite/schema/SchemaBuilders.java
+++ b/modules/schema/src/main/java/org/apache/ignite/schema/SchemaBuilders.java
@@ -72,6 +72,8 @@ public final class SchemaBuilders {
}
/**
+ * Creates primary index builder.
+ *
* @return Primary index builder.
*/
public static PrimaryIndexBuilder pkIndex() {
@@ -79,6 +81,8 @@ public final class SchemaBuilders {
}
/**
+ * Creates sorted index builder.
+ *
* @param name Index name.
* @return Sorted index builder.
*/
@@ -87,6 +91,8 @@ public final class SchemaBuilders {
}
/**
+ * Creates partial index builder.
+ *
* @param name Index name.
* @return Partial index builder.
*/
@@ -95,6 +101,8 @@ public final class SchemaBuilders {
}
/**
+ * Creates hash index builder.
+ *
* @param name Index name.
* @return Hash index builder.
*/
diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java b/modules/schema/src/main/java/org/apache/ignite/schema/package-info.java
similarity index 84%
copy from modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
copy to modules/schema/src/main/java/org/apache/ignite/schema/package-info.java
index 955effb..1f49289 100644
--- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
+++ b/modules/schema/src/main/java/org/apache/ignite/schema/package-info.java
@@ -16,7 +16,6 @@
*/
/**
- * <!-- Package description. -->
- * Contains schema description, row assembly and field accessor classes.
+ * Contains public schema definition helpers.
*/
-package org.apache.ignite.internal.schema;
\ No newline at end of file
+package org.apache.ignite.schema;
\ No newline at end of file
diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java b/modules/table/src/main/java/org/apache/ignite/binary/package-info.java
similarity index 84%
copy from modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
copy to modules/table/src/main/java/org/apache/ignite/binary/package-info.java
index 955effb..79411b2 100644
--- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/package-info.java
+++ b/modules/table/src/main/java/org/apache/ignite/binary/package-info.java
@@ -16,7 +16,6 @@
*/
/**
- * <!-- Package description. -->
- * Contains schema description, row assembly and field accessor classes.
+ * Contains public classes for custom user object serialization and access.
*/
-package org.apache.ignite.internal.schema;
\ No newline at end of file
+package org.apache.ignite.binary;
\ No newline at end of file