#2368 fix order of target parameter in documentation

2025-07-12 00:00:08 +08:00 · 2021-03-01 07:27:47 +01:00 · 2021-03-01 07:27:47 +01:00 · d5703d3ee8
commit d5703d3ee8
parent 85af901ea7
10 changed files with 27 additions and 27 deletions
--- a/core/src/main/java/org/mapstruct/Mapper.java
+++ b/core/src/main/java/org/mapstruct/Mapper.java
@ -47,7 +47,7 @@ import static org.mapstruct.NullValueCheckStrategy.ON_IMPLICIT_CONVERSION;
 *      uses = MarkMapper.class,
 *      injectionStrategy = InjectionStrategy.CONSTRUCTOR)
 * public interface CarMapper {
- *     &#64;Mapping(source = "mark", target = "name")
+ *     &#64;Mapping(target = "name", source = "mark")
 *     CarDto convertMap(CarEntity carEntity);
 * }
 * </code></pre>
--- a/core/src/main/java/org/mapstruct/Mappings.java
+++ b/core/src/main/java/org/mapstruct/Mappings.java
@ -23,8 +23,8 @@ import java.lang.annotation.Target;
 * &#64;Mapper
 * public interface MyMapper {
 *     &#64;Mappings({
- *         &#64;Mapping(source = "first", target = "firstProperty"),
- *         &#64;Mapping(source = "second", target = "secondProperty")
+ *         &#64;Mapping(target = "firstProperty", source = "first"),
+ *         &#64;Mapping(target = "secondProperty", source = "second")
 *     })
 *     HumanDto toHumanDto(Human human);
 * }
@ -33,8 +33,8 @@ import java.lang.annotation.Target;
 * // Java 8 and later
 * &#64;Mapper
 * public interface MyMapper {
- *     &#64;Mapping(source = "first", target = "firstProperty"),
- *     &#64;Mapping(source = "second", target = "secondProperty")
+ *     &#64;Mapping(target = "firstProperty", source = "first"),
+ *     &#64;Mapping(target = "secondProperty", source = "second")
 *     HumanDto toHumanDto(Human human);
 * }
 * </code></pre>
--- a/core/src/main/java/org/mapstruct/ValueMapping.java
+++ b/core/src/main/java/org/mapstruct/ValueMapping.java
@ -27,9 +27,9 @@ import java.lang.annotation.Target;
 *
 * public enum ExternalOrderType { RETAIL, B2B, SPECIAL, DEFAULT }
 *
- * &#64;ValueMapping(source = "EXTRA", target = "SPECIAL"),
- * &#64;ValueMapping(source = "STANDARD", target = "DEFAULT"),
- * &#64;ValueMapping(source = "NORMAL", target = "DEFAULT")
+ * &#64;ValueMapping(target = "SPECIAL", source = "EXTRA"),
+ * &#64;ValueMapping(target = "DEFAULT", source = "STANDARD"),
+ * &#64;ValueMapping(target = "DEFAULT", source = "NORMAL")
 * ExternalOrderType orderTypeToExternalOrderType(OrderType orderType);
 * </code>
 * Mapping result:
--- a/core/src/main/java/org/mapstruct/ValueMappings.java
+++ b/core/src/main/java/org/mapstruct/ValueMappings.java
@ -22,8 +22,8 @@ import java.lang.annotation.Target;
 * &#64;Mapper
 * public interface GenderMapper {
 *     &#64;ValueMappings({
- *         &#64;ValueMapping(source = "MALE", target = "M"),
- *         &#64;ValueMapping(source = "FEMALE", target = "F")
+ *         &#64;ValueMapping(target = "M", source = "MALE"),
+ *         &#64;ValueMapping(target = "F", source = "FEMALE")
 *     })
 *     GenderDto mapToDto(Gender gender);
 * }
@ -32,8 +32,8 @@ import java.lang.annotation.Target;
 * //Java 8 and later
 * &#64;Mapper
 * public interface GenderMapper {
- *     &#64;ValueMapping(source = "MALE", target = "M"),
- *     &#64;ValueMapping(source = "FEMALE", target = "F")
+ *     &#64;ValueMapping(target = "M", source = "MALE"),
+ *     &#64;ValueMapping(target = "F", source = "FEMALE")
 *     GenderDto mapToDto(Gender gender);
 * }
 * </code></pre>
--- a/documentation/src/main/asciidoc/chapter-11-reusing-mapping-configurations.asciidoc
+++ b/documentation/src/main/asciidoc/chapter-11-reusing-mapping-configurations.asciidoc
@ -54,7 +54,7 @@ Use the annotation `@InheritInverseConfiguration` to indicate that a method shal
@Mapper
 public interface CarMapper {

-    @Mapping(source = "numberOfSeats", target = "seatCount")
+    @Mapping(target = "seatCount", source = "numberOfSeats")
    CarDto carToDto(Car car);

    @InheritInverseConfiguration
--- a/documentation/src/main/asciidoc/chapter-3-defining-a-mapper.asciidoc
+++ b/documentation/src/main/asciidoc/chapter-3-defining-a-mapper.asciidoc
@ -16,11 +16,11 @@ To create a mapper simply define a Java interface with the required mapping meth
@Mapper
 public interface CarMapper {

-    @Mapping(source = "make", target = "manufacturer")
-    @Mapping(source = "numberOfSeats", target = "seatCount")
+    @Mapping(target = "manufacturer", source = "make")
+    @Mapping(target = "seatCount", source = "numberOfSeats")
    CarDto carToCarDto(Car car);

-    @Mapping(source = "name", target = "fullName")
+    @Mapping(target = "fullName", source = "name")
    PersonDto personToPersonDto(Person person);
 }
 ----
@ -236,8 +236,8 @@ MapStruct also supports mapping methods with several source parameters. This is
@Mapper
 public interface AddressMapper {

-    @Mapping(source = "person.description", target = "description")
-    @Mapping(source = "address.houseNo", target = "houseNumber")
+    @Mapping(target = "description", source = "person.description")
+    @Mapping(target = "houseNumber", source = "address.houseNo")
    DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Address address);
 }
 ----
@ -267,8 +267,8 @@ MapStruct also offers the possibility to directly refer to a source parameter.
@Mapper
 public interface AddressMapper {

-    @Mapping(source = "person.description", target = "description")
-    @Mapping(source = "hn", target = "houseNumber")
+    @Mapping(target = "description", source = "person.description")
+    @Mapping(target = "houseNumber", source = "hn")
    DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Integer hn);
 }
 ----
@ -368,7 +368,7 @@ public interface CustomerMapper {

    CustomerMapper INSTANCE = Mappers.getMapper( CustomerMapper.class );

-    @Mapping(source = "customerName", target = "name")
+    @Mapping(target = "name", source = "customerName")
    Customer toCustomer(CustomerDto customerDto);

    @InheritInverseConfiguration
--- a/documentation/src/main/asciidoc/chapter-8-mapping-values.asciidoc
+++ b/documentation/src/main/asciidoc/chapter-8-mapping-values.asciidoc
@ -20,9 +20,9 @@ public interface OrderMapper {
    OrderMapper INSTANCE = Mappers.getMapper( OrderMapper.class );

    @ValueMappings({
-        @ValueMapping(source = "EXTRA", target = "SPECIAL"),
-        @ValueMapping(source = "STANDARD", target = "DEFAULT"),
-        @ValueMapping(source = "NORMAL", target = "DEFAULT")
+        @ValueMapping(target = "SPECIAL", source = "EXTRA"),
+        @ValueMapping(target = "DEFAULT", source = "STANDARD"),
+        @ValueMapping(target = "DEFAULT", source = "NORMAL")
    })
    ExternalOrderType orderTypeToExternalOrderType(OrderType orderType);
 }
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/beanmapping/SourceReference.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/beanmapping/SourceReference.java
@ -34,7 +34,7 @@ import static org.mapstruct.ap.internal.util.Collections.last;
 * mapping method:
 *
 * <pre>
- * &#64;Mapping(source = "in.propA.propB" target = "propC")
+ * &#64;Mapping(target = "propC", source = "in.propA.propB")
 * TypeB mappingMethod(TypeA in);
 * </pre>
 *
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/beanmapping/TargetReference.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/beanmapping/TargetReference.java
@ -32,7 +32,7 @@ import static org.mapstruct.ap.internal.util.Collections.first;
 * method:
 *
 * <pre>
- * &#64;Mapping(source = "in.propA.propB" target = "propC")
+ * &#64;Mapping(target = "propC", source = "in.propA.propB")
 * TypeB mappingMethod(TypeA in);
 * </pre>
 *
--- a/readme.md
+++ b/readme.md
@ -42,7 +42,7 @@ public interface CarMapper {

    CarMapper INSTANCE = Mappers.getMapper( CarMapper.class );

-    @Mapping(source = "numberOfSeats", target = "seatCount")
+    @Mapping(target = "seatCount", source = "numberOfSeats")
    CarDto carToCarDto(Car car);
 }
 ```