(commons-lang) branch master updated: Correct Javadoc code example (#1400)

[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 78741664e Correct Javadoc code example (#1400)
78741664e is described below

commit 78741664e520586905532780bc330100dff21505
Author: Ken Dombeck <kdomb...@users.noreply.github.com>
AuthorDate: Fri Jun 13 15:23:06 2025 -0500

    Correct Javadoc code example (#1400)
    
    * Javadoc: Add type to suppress "Raw use of parameterized class" warning
    
    * Javadoc: Remove usage of constructor since it has been deprecated
    
    * Javadoc: Remove extra closing parentheses
    
    * Javadoc: Need second build() method to return a DiffResult as the first 
build method returns a ReflectionDiffBuilder
    
    ---------
    
    Co-authored-by: Ken Dombeck <ken.domb...@target.com>
---
 src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java     | 6 +++---
 .../org/apache/commons/lang3/builder/ReflectionDiffBuilder.java     | 5 +++--
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java 
b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
index 78b05e3f0..119013ad2 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
@@ -41,12 +41,12 @@
  *
  *   ...
  *
- *   public DiffResult diff(Person obj) {
+ *   public DiffResult<Person> diff(Person obj) {
  *     // No need for null check, as NullPointerException correct if obj is 
null
- *     return new DiffBuilder.<Person>builder()
+ *     return DiffBuilder.<Person>builder()
  *         .setLeft(this)
  *         .setRight(obj)
- *         .setStyle(ToStringStyle.SHORT_PREFIX_STYLE))
+ *         .setStyle(ToStringStyle.SHORT_PREFIX_STYLE)
  *         .build()
  *       .append("name", this.name, obj.name)
  *       .append("age", this.age, obj.age)
diff --git 
a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java 
b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
index 2c1c6e736..363feb017 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
@@ -43,15 +43,16 @@
  *   boolean smoker;
  *   ...
  *
- *   public DiffResult diff(Person obj) {
+ *   public DiffResult<Person> diff(Person obj) {
  *     // No need for null check, as NullPointerException correct if obj is 
null
- *     return new ReflectionDiffBuilder.<Person>builder()
+ *     return ReflectionDiffBuilder.<Person>builder()
  *       .setDiffBuilder(DiffBuilder.<Person>builder()
  *           .setLeft(this)
  *           .setRight(obj)
  *           .setStyle(ToStringStyle.SHORT_PREFIX_STYLE)
  *           .build())
  *       .setExcludeFieldNames("userName", "password")
+ *       .build()
  *       .build();
  *   }
  * }