This is an automated email from the ASF dual-hosted git repository.
snazy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new ac346d62 Javadoc fixes (#189)
ac346d62 is described below
commit ac346d6268ac79797c77383f03a5738127a8b6f3
Author: Robert Stupp <[email protected]>
AuthorDate: Wed Aug 28 05:49:10 2024 +0200
Javadoc fixes (#189)
---
build-logic/src/main/kotlin/polaris-java.gradle.kts | 6 ++++++
.../java/org/apache/polaris/core/entity/PolarisEntityConstants.java | 5 +++--
.../apache/polaris/core/persistence/PolarisMetaStoreManager.java | 2 +-
.../polaris/core/persistence/PolarisMetaStoreManagerImpl.java | 2 +-
.../apache/polaris/core/persistence/PolarisObjectMapperUtil.java | 2 +-
.../polaris/core/storage/PolarisStorageConfigurationInfo.java | 2 +-
.../org/apache/polaris/core/storage/PolarisStorageIntegration.java | 4 ++--
.../java/org/apache/polaris/core/storage/azure/AzureLocation.java | 2 +-
8 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/build-logic/src/main/kotlin/polaris-java.gradle.kts
b/build-logic/src/main/kotlin/polaris-java.gradle.kts
index 13722103..3690e1a9 100644
--- a/build-logic/src/main/kotlin/polaris-java.gradle.kts
+++ b/build-logic/src/main/kotlin/polaris-java.gradle.kts
@@ -83,3 +83,9 @@ spotless {
}
dependencies {
errorprone(versionCatalogs.named("libs").findLibrary("errorprone").get()) }
+
+tasks.withType<Javadoc>().configureEach {
+ val opt = options as CoreJavadocOptions
+ // don't spam log w/ "warning: no @param/@return"
+ opt.addStringOption("Xdoclint:-reference", "-quiet")
+}
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/entity/PolarisEntityConstants.java
b/polaris-core/src/main/java/org/apache/polaris/core/entity/PolarisEntityConstants.java
index 5addde08..26d3c09a 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/entity/PolarisEntityConstants.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/entity/PolarisEntityConstants.java
@@ -58,8 +58,9 @@ public class PolarisEntityConstants {
"CREDENTIAL_ROTATION_REQUIRED";
/**
- * Name format of storage integration for polaris entity:
POLARIS_<catalog_id>_<entity_id> . This
- * name format gives us flexibility to switch to use integration name in the
future if we want.
+ * Name format of storage integration for polaris entity: {@code
+ * POLARIS_<catalog_id>_<entity_id>}. This name format gives us flexibility
to switch to use
+ * integration name in the future if we want.
*/
public static final String POLARIS_STORAGE_INT_NAME_FORMAT = "POLARIS_%s_%s";
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManager.java
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManager.java
index a0df1971..c057a22c 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManager.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManager.java
@@ -1323,7 +1323,7 @@ public interface PolarisMetaStoreManager {
* @param entityId the entity id
* @param actions a set of operation actions: READ/WRITE/LIST/DELETE/ALL
* @param locations a set of locations to verify
- * @return a Map of <location, validate result>, a validate result value
looks like this
+ * @return a Map of {@code <location, validate result>}, a validate result
value looks like this
* <pre>
* {
* "status" : "failure",
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManagerImpl.java
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManagerImpl.java
index 10396aba..b05129fa 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManagerImpl.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisMetaStoreManagerImpl.java
@@ -855,7 +855,7 @@ public class PolarisMetaStoreManagerImpl implements
PolarisMetaStoreManager {
}
/**
- * Given the serialized properties, deserialize those to a Map<String,
String>
+ * Given the serialized properties, deserialize those to a {@code
Map<String, String>}
*
* @param properties a JSON string representing the set of properties
* @return a Map of string
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisObjectMapperUtil.java
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisObjectMapperUtil.java
index b4c0aff5..7f85580f 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisObjectMapperUtil.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/persistence/PolarisObjectMapperUtil.java
@@ -89,7 +89,7 @@ public class PolarisObjectMapperUtil {
}
/**
- * Given the serialized properties, deserialize those to a Map<String,
String>
+ * Given the serialized properties, deserialize those to a {@code
Map<String, String>}
*
* @param properties a JSON string representing the set of properties
* @return a Map of string
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageConfigurationInfo.java
b/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageConfigurationInfo.java
index a169cd55..504e3687 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageConfigurationInfo.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageConfigurationInfo.java
@@ -51,7 +51,7 @@ import org.slf4j.LoggerFactory;
* <pre>
* 1. locations that allows polaris to get access to
* 2. cloud identity info that a service principle can request access token to
the locations
- * </pre</>
+ * </pre>
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)
@JsonSubTypes({
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageIntegration.java
b/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageIntegration.java
index 26554c6f..7067ec1e 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageIntegration.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageIntegration.java
@@ -75,8 +75,8 @@ public abstract class PolarisStorageIntegration<T extends
PolarisStorageConfigur
*
* @param actions a set of operation actions to validate, like
LIST/READ/DELETE/WRITE/ALL
* @param locations a set of locations to get access to
- * @return A Map of string, representing the result of validation, the key
value is <location,
- * validate result>. A validate result looks like this
+ * @return A Map of string, representing the result of validation, the key
value is {@code
+ * <location, validate result>}. A validate result looks like this
* <pre>
* {
* "status" : "failure",
diff --git
a/polaris-core/src/main/java/org/apache/polaris/core/storage/azure/AzureLocation.java
b/polaris-core/src/main/java/org/apache/polaris/core/storage/azure/AzureLocation.java
index 6d2401ef..80b86f53 100644
---
a/polaris-core/src/main/java/org/apache/polaris/core/storage/azure/AzureLocation.java
+++
b/polaris-core/src/main/java/org/apache/polaris/core/storage/azure/AzureLocation.java
@@ -40,7 +40,7 @@ public class AzureLocation {
/**
* Construct an Azure location object from a location uri, it should follow
this pattern:
*
- * <pre> abfs[s]://[<container>@]<storage account host>/<file path> </pre>
+ * <p>{@code abfs[s]://[<container>@]<storage account host>/<file path>}
*
* @param location a uri
*/
