[spark] branch branch-3.0 updated: [SPARK-33115][BUILD][DOCS] Fix javadoc errors in `kvstore` and `unsafe` modules

[gurwls223]

This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch branch-3.0
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/branch-3.0 by this push:
     new 9430ae6  [SPARK-33115][BUILD][DOCS] Fix javadoc errors in `kvstore` 
and `unsafe` modules
9430ae6 is described below

commit 9430ae673010a7c24f09b5d041f9f9304d27c233
Author: Denis Pyshev <g...@gemelen.net>
AuthorDate: Tue Oct 13 21:37:26 2020 +0900

    [SPARK-33115][BUILD][DOCS] Fix javadoc errors in `kvstore` and `unsafe` 
modules
    
    ### What changes were proposed in this pull request?
    
    Fix Javadoc generation errors in `kvstore` and `unsafe` modules according 
to error message hints.
    
    ### Why are the changes needed?
    
    Fixes `doc` task failures which prevented other tasks successful executions 
(eg `publishLocal` task depends on `doc` task).
    
    ### Does this PR introduce _any_ user-facing change?
    
    No.
    Meaning of text in Javadoc is stayed the same.
    
    ### How was this patch tested?
    
    Run `build/sbt kvstore/Compile/doc`, `build/sbt unsafe/Compile/doc` and 
`build/sbt doc` without errors.
    
    Closes #30007 from gemelen/feature/doc-task-fix.
    
    Authored-by: Denis Pyshev <g...@gemelen.net>
    Signed-off-by: HyukjinKwon <gurwls...@apache.org>
    (cherry picked from commit 1b0875b6924b4f29aa3cdecc26f8103fcae3dc55)
    Signed-off-by: HyukjinKwon <gurwls...@apache.org>
---
 .../src/main/java/org/apache/spark/util/kvstore/InMemoryStore.java   | 5 +++--
 .../src/main/java/org/apache/spark/unsafe/types/UTF8String.java      | 2 +-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git 
a/common/kvstore/src/main/java/org/apache/spark/util/kvstore/InMemoryStore.java 
b/common/kvstore/src/main/java/org/apache/spark/util/kvstore/InMemoryStore.java
index 42e090b..431c7e4 100644
--- 
a/common/kvstore/src/main/java/org/apache/spark/util/kvstore/InMemoryStore.java
+++ 
b/common/kvstore/src/main/java/org/apache/spark/util/kvstore/InMemoryStore.java
@@ -164,8 +164,9 @@ public class InMemoryStore implements KVStore {
   }
 
   /**
-   * An alias class for the type "ConcurrentHashMap<Comparable<Object>, 
Boolean>", which is used
-   * as a concurrent hashset for storing natural keys and the boolean value 
doesn't matter.
+   * An alias class for the type "{@literal 
ConcurrentHashMap<Comparable<Object>, Boolean>}",
+   * which is used as a concurrent hashset for storing natural keys
+   * and the boolean value doesn't matter.
    */
   private static class NaturalKeys extends 
ConcurrentHashMap<Comparable<Object>, Boolean> {}
 
diff --git 
a/common/unsafe/src/main/java/org/apache/spark/unsafe/types/UTF8String.java 
b/common/unsafe/src/main/java/org/apache/spark/unsafe/types/UTF8String.java
index 43bd797..b8dda22 100644
--- a/common/unsafe/src/main/java/org/apache/spark/unsafe/types/UTF8String.java
+++ b/common/unsafe/src/main/java/org/apache/spark/unsafe/types/UTF8String.java
@@ -563,7 +563,7 @@ public final class UTF8String implements 
Comparable<UTF8String>, Externalizable,
   }
 
   /**
-   * Trims whitespaces (<= ASCII 32) from both ends of this string.
+   * Trims whitespaces ({@literal <=} ASCII 32) from both ends of this string.
    *
    * Note that, this method is the same as java's {@link String#trim}, and 
different from
    * {@link UTF8String#trim()} which remove only spaces(= ASCII 32) from both 
ends.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org