You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by pr...@apache.org on 2018/04/17 16:41:50 UTC
[geode] branch develop updated: GEODE-4954,
GEODE-4955: Remove trivial javadoc stubs and empty blocks: Add
removal to spotless (#1781)
This is an automated email from the ASF dual-hosted git repository.
prhomberg pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new cb5fb79 GEODE-4954, GEODE-4955: Remove trivial javadoc stubs and empty blocks: Add removal to spotless (#1781)
cb5fb79 is described below
commit cb5fb79d0efbf21ec0ba32be6ba0e5733b17fff9
Author: Patrick Rhomberg <pr...@pivotal.io>
AuthorDate: Tue Apr 17 09:41:47 2018 -0700
GEODE-4954, GEODE-4955: Remove trivial javadoc stubs and empty blocks: Add removal to spotless (#1781)
* Remove trivial javadoc stubs as part of spotless.
* Remove empty javadoc and comment blocks as part of spotless.
* Apply spotless to JDBC's ConnectionService.
---
.../internal/configuration/ConnectorService.java | 80 +++++++++-------------
gradle/spotless.gradle | 18 ++++-
2 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/geode-connectors/src/main/java/org/apache/geode/connectors/jdbc/internal/configuration/ConnectorService.java b/geode-connectors/src/main/java/org/apache/geode/connectors/jdbc/internal/configuration/ConnectorService.java
index 72b06a8..9d5f3bb 100644
--- a/geode-connectors/src/main/java/org/apache/geode/connectors/jdbc/internal/configuration/ConnectorService.java
+++ b/geode-connectors/src/main/java/org/apache/geode/connectors/jdbc/internal/configuration/ConnectorService.java
@@ -179,9 +179,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the name property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getName() {
@@ -195,9 +194,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the name property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setName(String value) {
@@ -270,9 +268,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the name property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getName() {
@@ -282,9 +279,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the name property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setName(String value) {
@@ -294,9 +290,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the url property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getUrl() {
@@ -306,9 +301,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the url property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setUrl(String value) {
@@ -318,9 +312,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the user property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getUser() {
@@ -330,9 +323,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the user property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setUser(String value) {
@@ -342,9 +334,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the password property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getPassword() {
@@ -354,9 +345,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the password property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setPassword(String value) {
@@ -366,9 +356,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the parameters property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getParameters() {
@@ -378,9 +367,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the parameters property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setParameters(String value) {
@@ -782,9 +770,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the fieldName property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getFieldName() {
@@ -794,9 +781,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the fieldName property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setFieldName(String value) {
@@ -806,9 +792,8 @@ public class ConnectorService implements CacheElement {
/**
* Gets the value of the columnName property.
*
- * @return
- * possible object is
- * {@link String }
+ * possible object is
+ * {@link String }
*
*/
public String getColumnName() {
@@ -818,9 +803,8 @@ public class ConnectorService implements CacheElement {
/**
* Sets the value of the columnName property.
*
- * @param value
- * allowed object is
- * {@link String }
+ * allowed object is
+ * {@link String }
*
*/
public void setColumnName(String value) {
diff --git a/gradle/spotless.gradle b/gradle/spotless.gradle
index a5cd252..22fe693 100644
--- a/gradle/spotless.gradle
+++ b/gradle/spotless.gradle
@@ -27,7 +27,7 @@ subprojects {
// As the method name suggests, bump this number if any of the below "custom" rules change.
// Spotless will not run on unchanged files unless this number changes.
- bumpThisNumberIfACustomStepChanges(0)
+ bumpThisNumberIfACustomStepChanges(2)
removeUnusedImports()
@@ -38,6 +38,22 @@ subprojects {
// Enforce style import order
importOrderFile "${project(':geode-core').projectDir}/../etc/eclipseOrganizeImports.importorder"
+ custom 'Remove unhelpful javadoc stubs', {
+ // e.g., remove the following lines:
+ // "* @param paramName"
+ // "* @throws ExceptionType"
+ // "* @return returnType"'
+ // Multiline to allow anchors on newlines
+ it.replaceAll(/(?m)^ *\* *@(?:param|throws|return) *\w* *\n/, '')
+ }
+ custom 'Remove any empty Javadocs and block comments', {
+ // Matches any /** [...] */ or /* [...] */ that contains:
+ // (a) only whitespace
+ // (b) trivial information, such as "@param paramName" or @throws ExceptionType
+ // without any additional information. This information is implicit in the signature.
+ it.replaceAll(/\/\*+\s*\n(\s*\*\s*\n)*\s*\*+\/\s*\n/, '')
+ }
+
// Enforce style modifier order
custom 'Modifier ordering', {
def modifierRanking = [
--
To stop receiving notification emails like this one, please contact
prhomberg@apache.org.