You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by GitBox <gi...@apache.org> on 2021/12/14 17:08:27 UTC
[GitHub] [accumulo-testing] EdColeman opened a new pull request #178: fix javadoc warnings
EdColeman opened a new pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178
Fixes errors when building java docs (mvn clean verify javadoc:jar)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] EdColeman commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
EdColeman commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769677662
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
Verified that the changes in #180 eliminates the warnings - the changes in this PR are not necessary to remove the warnings when building with maven.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769610070
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
I think you have your warnings set weird. We normally exclude missing standard javadocs from warnings, because it forces us to put things in like this, which doesn't add any value from what you can see already from the method signature.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769679673
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
Cool, but if you want to keep any of the updated javadocs, feel free to do so. Some of these could still be useful for their explanatory power, and not just to eliminate warnings.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769683445
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/RandWalkEnv.java
##########
@@ -47,6 +47,10 @@ public RandWalkEnv(String testPropsPath, String clientPropsPath) {
* if any of the numeric batch writer configuration properties cannot be parsed
* @throws NumberFormatException
* if any configuration property cannot be parsed
+ * @throws AccumuloException
+ * if an Accumulo exception occurs
+ * @throws AccumuloSecurityException
+ * if an Accumulo security exception occurs
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/TestEnv.java
##########
@@ -168,6 +172,8 @@ public String getYarnResourceManager() {
/**
* Gets an Accumulo client. The same client is reused after the first call.
+ *
+ * @return the Accumulo client
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/Node.java
##########
@@ -36,6 +36,10 @@
* Random walk state passed between nodes
* @param env
* test environment
+ * @param props
+ * properties
+ * @throws Exception
+ * if an exception occurs
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/TestEnv.java
##########
@@ -153,6 +155,8 @@ public Configuration getHadoopConfiguration() {
/**
* Gets an authentication token based on the configured password.
+ *
+ * @return the AuthenticationToken
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/State.java
##########
@@ -51,13 +51,18 @@ public void set(String key, Object value) {
/**
* Resets the Random object.
+ *
+ * @param rand
+ * a random number generator.
*/
public void setRandom(Random rand) {
this.random = rand;
}
/**
* Gets the random object.
+ *
+ * @return the random generator
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/State.java
##########
@@ -51,13 +51,18 @@ public void set(String key, Object value) {
/**
* Resets the Random object.
+ *
+ * @param rand
+ * a random number generator.
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
```suggestion
```
##########
File path: src/main/java/org/apache/accumulo/testing/TestEnv.java
##########
@@ -84,6 +84,8 @@ public Properties getTestProperties() {
}
/**
+ * @param key
+ * the property name
Review comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] EdColeman commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
EdColeman commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769685559
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
The comment
```Some of these add value, but a lot of them just repeat information already shown in the method signatures, which isn't useful. ```
is subjective - the changes I added were from a simple reading of the signature / or the code, not from a deep understanding - so I could argue that they add all add very little information.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769681541
##########
File path: src/main/java/org/apache/accumulo/testing/TestEnv.java
##########
@@ -84,6 +84,8 @@ public Properties getTestProperties() {
}
/**
+ * @param key
+ * the property name
Review comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] DomGarguilo commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
DomGarguilo commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769017731
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/Framework.java
##########
@@ -40,6 +40,12 @@ public static Framework getInstance() {
*
* @param startName
* Full name of starting graph or test
+ * @param env
+ * the test environment
+ * @param state
+ * tRandom walk state passed between nodes
Review comment:
```suggestion
* Random walk state passed between nodes
```
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * is an exception occurs.
Review comment:
```suggestion
* if an exception occurs
```
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/RandWalkEnv.java
##########
@@ -47,6 +47,10 @@ public RandWalkEnv(String testPropsPath, String clientPropsPath) {
* if any of the numeric batch writer configuration properties cannot be parsed
* @throws NumberFormatException
* if any configuration property cannot be parsed
+ * @throws AccumuloException
+ * if an Accumulo exception occurs
+ * @throws AccumuloSecurityException
+ * is an Accumulo security exception occurs.
Review comment:
```suggestion
* if an Accumulo security exception occurs
```
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/State.java
##########
@@ -107,6 +112,8 @@ public String getRandomNamespace() {
/**
* Gets a random table name
+ *
+ * @return a random table name from current table names.
Review comment:
```suggestion
* @return a random table name from the list of current table names.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] EdColeman commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
EdColeman commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769653986
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
For the record - I saw the errors in the maven build - it was not a setting in my IDE.
If the update to the configuration eliminates the warning, this PR can be rejected.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769686023
##########
File path: src/main/java/org/apache/accumulo/testing/randomwalk/State.java
##########
@@ -107,6 +112,8 @@ public String getRandomNamespace() {
/**
* Gets a random table name
+ *
Review comment:
Removing whitespace
```suggestion
*
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii merged pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii merged pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo-testing] ctubbsii commented on a change in pull request #178: fix javadoc warnings
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #178:
URL: https://github.com/apache/accumulo-testing/pull/178#discussion_r769610070
##########
File path: src/main/java/org/apache/accumulo/testing/continuous/UndefinedAnalyzer.java
##########
@@ -247,6 +247,11 @@ TabletAssignment findMostRecentAssignment(String row, long time1, long time2) {
/**
* Class to analyze undefined references and accumulo logs to isolate the time/tablet where data
* was lost.
+ *
+ * @param args
+ * the command line arguments
+ * @throws Exception
+ * if an exception occurs
Review comment:
We normally exclude missing standard javadocs from warnings, because it forces us to put things in like this, which doesn't add any value from what you can see already from the method signature. I updated this configuration by copying from the main project in #180
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org