From 811cd569bb80ed45f0da74cb603d9bfea774ad0c Mon Sep 17 00:00:00 2001
From: Johnny Lim <izeye@naver.com>
Date: Tue, 27 Sep 2022 02:02:01 +0900
Subject: [PATCH] Javadoc and documentation polishing (#3026)

---
 core/src/main/java/org/mapstruct/EnumMapping.java    |  2 +-
 .../java/org/mapstruct/NullValueCheckStrategy.java   |  2 +-
 .../mapstruct/ap/internal/model/HelperMethod.java    |  2 +-
 .../internal/model/source/builtin/BuiltInMethod.java |  2 +-
 .../java/org/mapstruct/ap/internal/util/Message.java |  2 +-
 .../ap/internal/model/StreamMappingMethod.ftl        |  2 +-
 .../mapstruct/ap/test/bugs/_1719/Issue1719Test.java  |  4 ++--
 .../test/context/ContextParameterErroneousTest.java  |  2 +-
 readme.md                                            | 12 ++++++------
 9 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/core/src/main/java/org/mapstruct/EnumMapping.java b/core/src/main/java/org/mapstruct/EnumMapping.java
index ba3a5e0cb..375f969b0 100644
--- a/core/src/main/java/org/mapstruct/EnumMapping.java
+++ b/core/src/main/java/org/mapstruct/EnumMapping.java
@@ -98,7 +98,7 @@ public @interface EnumMapping {
      * <ul>
      *     <li>{@link MappingConstants#SUFFIX_TRANSFORMATION} - applies the given {@link #configuration()} as a
      *     suffix to the source enum</li>
-     *     <li>{@link MappingConstants#STRIP_SUFFIX_TRANSFORMATION} - strips the the given {@link #configuration()}
+     *     <li>{@link MappingConstants#STRIP_SUFFIX_TRANSFORMATION} - strips the given {@link #configuration()}
      *     from the end of the source enum</li>
      *     <li>{@link MappingConstants#PREFIX_TRANSFORMATION} - applies the given {@link #configuration()} as a
      *     prefix to the source enum</li>
diff --git a/core/src/main/java/org/mapstruct/NullValueCheckStrategy.java b/core/src/main/java/org/mapstruct/NullValueCheckStrategy.java
index 446b879d9..22dba7c58 100644
--- a/core/src/main/java/org/mapstruct/NullValueCheckStrategy.java
+++ b/core/src/main/java/org/mapstruct/NullValueCheckStrategy.java
@@ -8,7 +8,7 @@ package org.mapstruct;
 /**
  * Strategy for dealing with null source values.
  *
- * <b>Note:</b> This strategy is not in effect when the a specific source presence check method is defined
+ * <b>Note:</b> This strategy is not in effect when a specific source presence check method is defined
  * in the service provider interface (SPI).
  *  <p>
  *  <b>Note</b>: some types of mappings (collections, maps), in which MapStruct is instructed to use a getter or adder
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/HelperMethod.java b/processor/src/main/java/org/mapstruct/ap/internal/model/HelperMethod.java
index 35b35aee7..6ff85c585 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/HelperMethod.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/HelperMethod.java
@@ -176,7 +176,7 @@ public abstract class HelperMethod implements Method {
      *
      * @param parameter source
      * @param returnType target
-     * @return {@code true}, iff the the type variables match
+     * @return {@code true}, iff the type variables match
      */
     public boolean doTypeVarsMatch(Type parameter, Type returnType) {
         return true;
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/source/builtin/BuiltInMethod.java b/processor/src/main/java/org/mapstruct/ap/internal/model/source/builtin/BuiltInMethod.java
index f46b20157..6d4187215 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/source/builtin/BuiltInMethod.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/source/builtin/BuiltInMethod.java
@@ -190,7 +190,7 @@ public abstract class BuiltInMethod implements Method {
      *
      * @param parameter source
      * @param returnType target
-     * @return {@code true}, iff the the type variables match
+     * @return {@code true}, iff the type variables match
      */
     public boolean doTypeVarsMatch(Type parameter, Type returnType) {
         return true;
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/util/Message.java b/processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
index 92951ad52..29600489f 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/util/Message.java
@@ -159,7 +159,7 @@ public enum Message {
     RETRIEVAL_NO_INPUT_ARGS( "Can't generate mapping method with no input arguments." ),
     RETRIEVAL_DUPLICATE_MAPPING_TARGETS( "Can't generate mapping method with more than one @MappingTarget parameter." ),
     RETRIEVAL_VOID_MAPPING_METHOD( "Can't generate mapping method with return type void." ),
-    RETRIEVAL_NON_ASSIGNABLE_RESULTTYPE( "The result type is not assignable to the the return type." ),
+    RETRIEVAL_NON_ASSIGNABLE_RESULTTYPE( "The result type is not assignable to the return type." ),
     RETRIEVAL_ITERABLE_TO_NON_ITERABLE( "Can't generate mapping method from iterable type from java stdlib to non-iterable type." ),
     RETRIEVAL_MAPPING_HAS_TARGET_TYPE_PARAMETER( "Can't generate mapping method that has a parameter annotated with @TargetType." ),
     RETRIEVAL_NON_ITERABLE_TO_ITERABLE( "Can't generate mapping method from non-iterable type to iterable type from java stdlib." ),
diff --git a/processor/src/main/resources/org/mapstruct/ap/internal/model/StreamMappingMethod.ftl b/processor/src/main/resources/org/mapstruct/ap/internal/model/StreamMappingMethod.ftl
index 7b5b44bd5..29977bdd5 100644
--- a/processor/src/main/resources/org/mapstruct/ap/internal/model/StreamMappingMethod.ftl
+++ b/processor/src/main/resources/org/mapstruct/ap/internal/model/StreamMappingMethod.ftl
@@ -114,7 +114,7 @@
     <#else>
         <#-- Streams are immutable so we can't update them -->
         <#if !existingInstanceMapping>
-            <#--TODO fhr: after the the result is no longer the same instance, how does it affect the
+            <#--TODO fhr: after the result is no longer the same instance, how does it affect the
                 Before mapping methods. Does it even make sense to have before mapping on a stream? -->
             <#if sourceParameter.type.arrayType>
                 <@returnLocalVarDefOrUpdate>Stream.of( ${sourceParameter.name} )<@streamMapSupplier />;</@returnLocalVarDefOrUpdate>
diff --git a/processor/src/test/java/org/mapstruct/ap/test/bugs/_1719/Issue1719Test.java b/processor/src/test/java/org/mapstruct/ap/test/bugs/_1719/Issue1719Test.java
index 182e1849b..7a8665e49 100644
--- a/processor/src/test/java/org/mapstruct/ap/test/bugs/_1719/Issue1719Test.java
+++ b/processor/src/test/java/org/mapstruct/ap/test/bugs/_1719/Issue1719Test.java
@@ -23,8 +23,8 @@ public class Issue1719Test {
 
     /**
      * For adder methods MapStuct cannot generate an update method. MapStruct would cannot know how to remove objects
-     * from the child-parent relation. It cannot even assume that the the collection can be cleared at forehand.
-     * Therefore the only sensible choice is for MapStruct to create a create method for the target elements.
+     * from the child-parent relation. It cannot even assume that the collection can be cleared at forehand.
+     * Therefore, the only sensible choice is for MapStruct to create a create method for the target elements.
      */
     @ProcessorTest
     @WithClasses(Issue1719Mapper.class)
diff --git a/processor/src/test/java/org/mapstruct/ap/test/context/ContextParameterErroneousTest.java b/processor/src/test/java/org/mapstruct/ap/test/context/ContextParameterErroneousTest.java
index 77fefe756..46bb08cb7 100644
--- a/processor/src/test/java/org/mapstruct/ap/test/context/ContextParameterErroneousTest.java
+++ b/processor/src/test/java/org/mapstruct/ap/test/context/ContextParameterErroneousTest.java
@@ -19,7 +19,7 @@ import org.mapstruct.ap.testutil.compilation.annotation.ExpectedCompilationOutco
 /**
  * Tests the erroneous usage of the {@link Context} annotation in the following situations:
  * <ul>
- * <li>using the the same context parameter type twice in the same method
+ * <li>using the same context parameter type twice in the same method
  * </ul>
  *
  * @author Andreas Gudian
diff --git a/readme.md b/readme.md
index e5811060a..e1ee8f9de 100644
--- a/readme.md
+++ b/readme.md
@@ -114,7 +114,7 @@ plugins {
 
 dependencies {
     ...
-    compile 'org.mapstruct:mapstruct:1.5.2.Final'
+    implementation 'org.mapstruct:mapstruct:1.5.2.Final'
 
     annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.2.Final'
     testAnnotationProcessor 'org.mapstruct:mapstruct-processor:1.5.2.Final' // if you are using mapstruct in test code
@@ -122,7 +122,7 @@ dependencies {
 ...
 ```
 
-If you don't work with a dependency management tool, you can obtain a distribution bundle from [SourceForge](https://sourceforge.net/projects/mapstruct/files/).
+If you don't work with a dependency management tool, you can obtain a distribution bundle from [Releases page](https://github.com/mapstruct/mapstruct/releases).
 
 ## Documentation and getting help
 
@@ -132,16 +132,16 @@ To learn more about MapStruct, refer to the [project homepage](http://mapstruct.
 
 MapStruct uses Maven for its build. Java 11 is required for building MapStruct from source. To build the complete project, run
 
-    mvn clean install
+    ./mvnw clean install
 
 from the root of the project directory. To skip the distribution module, run 
 
-    mvn clean install -DskipDistribution=true
+    ./mvnw clean install -DskipDistribution=true
     
 ## Importing into IDE
 
-MapStruct uses the gem annotation processor to generate mapping gems for it's own annotations.
-Therefore for seamless integration within an IDE annotation processing needs to be enabled.
+MapStruct uses the gem annotation processor to generate mapping gems for its own annotations.
+Therefore, for seamless integration within an IDE annotation processing needs to be enabled.
 
 ### IntelliJ