[commons-lang] branch master updated: Fixed Javadocs for setTestRecursive() (#556)

[ggregory]

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

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git


The following commit(s) were added to refs/heads/master by this push:
     new a7be33e  Fixed Javadocs for setTestRecursive() (#556)
a7be33e is described below

commit a7be33e9c6603cb15fb873ab721fbca1ef300600
Author: Miguel Muñoz <swingguy1...@yahoo.com>
AuthorDate: Wed Jun 24 05:46:21 2020 -0700

    Fixed Javadocs for setTestRecursive() (#556)
---
 src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java 
b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
index 6bd1058..50d8118 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -245,9 +245,12 @@ public class EqualsBuilder implements Builder<Boolean> {
     }
 
     /**
-     * Set whether to include transient fields when reflectively comparing 
objects.
-     * @param testRecursive  whether to do a recursive test
+     * Set whether to test fields recursively, instead of using their equals 
method, when reflectively comparing objects.
+     * String objects, which cache a hash value, are automatically excluded 
from recursive testing.
+     * You may specify other exceptions by calling {@link 
#setBypassReflectionClasses(List)}.
+     * @param testRecursive whether to do a recursive test
      * @return EqualsBuilder - used to chain calls.
+     * @see #setBypassReflectionClasses(List)
      * @since 3.6
      */
     public EqualsBuilder setTestRecursive(final boolean testRecursive) {
@@ -265,6 +268,7 @@ public class EqualsBuilder implements Builder<Boolean> {
      * your own set of classes here, remember to include {@code String} class, 
too.</p>
      * @param bypassReflectionClasses  classes to bypass reflection test
      * @return EqualsBuilder - used to chain calls.
+     * @see #setTestRecursive(boolean)
      * @since 3.8
      */
     public EqualsBuilder setBypassReflectionClasses(final List<Class<?>> 
bypassReflectionClasses) {