improved documentation

src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionEntity.java

@@ -53,12 +53,25 @@ public class HsOfficeCoopAssetsTransactionEntity implements Stringifyable, HasUu
     @Column(name = "valuedate")
     private LocalDate valueDate;
 
+    /**
+     * The signed value which directly affects the booking balance.
+     *
+     * <p>This means, that a DEPOSIT is always positive, a DISBURSAL is always negative,
+     * but an ADJUSTMENT can bei either positive or negative.
+     * See {@link HsOfficeCoopAssetsTransactionType} for</p> more information.
+     */
     @Column(name = "assetvalue")
     private BigDecimal assetValue;
 
+    /**
+     *  The booking reference.
+     */
     @Column(name = "reference")
     private String reference;
 
+    /**
+     * An optional arbitrary comment.
+     */
     @Column(name = "comment")
     private String comment;
 

src/main/java/net/hostsharing/hsadminng/hs/office/coopassets/HsOfficeCoopAssetsTransactionType.java

@@ -1,12 +1,43 @@
 package net.hostsharing.hsadminng.hs.office.coopassets;
 
 public enum HsOfficeCoopAssetsTransactionType {
-    ADJUSTMENT, // correction of wrong bookings
-    DEPOSIT,    // payment received from member after signing shares, >0
-    DISBURSAL,  // payment send to member after cancellation of shares, <0
-    TRANSFER,   // transferring shares to another member, <0
-    ADOPTION,   // receiving shares from another member, >0
-    CLEARING,   // settlement with members dept, <0
-    LOSS,       // assignment of balance sheet loss in case of cancellation of shares, <0
-    LIMITATION  // limitation period was reached after impossible disbursal, <0
+    /**
+     * correction of wrong bookings, value can be positive or negative
+     */
+    ADJUSTMENT,
+
+    /**
+     * payment received from member after signing shares, value >0
+     */
+    DEPOSIT,
+
+    /**
+     * payment send to member after cancellation of shares, value <0
+     */
+    DISBURSAL,
+
+    /**
+     * transferring shares to another member, value <0
+     */
+    TRANSFER,
+
+    /**
+     * receiving shares from another member, value >0
+     */
+    ADOPTION,
+
+    /**
+     * settlement with members dept, value <0
+     */
+    CLEARING,
+
+    /**
+     * assignment of balance sheet loss in case of cancellation of shares, value <0
+     */
+    LOSS,
+
+    /**
+     * limitation period was reached after impossible disbursal, value <0
+     */
+    LIMITATION
 }

src/main/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionEntity.java

@@ -2,6 +2,7 @@ package net.hostsharing.hsadminng.hs.office.coopshares;
 
 import lombok.*;
 import net.hostsharing.hsadminng.errors.DisplayName;
+import net.hostsharing.hsadminng.hs.office.coopassets.HsOfficeCoopAssetsTransactionType;
 import net.hostsharing.hsadminng.hs.office.membership.HsOfficeMembershipEntity;
 import net.hostsharing.hsadminng.hs.office.migration.HasUuid;
 import net.hostsharing.hsadminng.stringify.Stringify;
@@ -46,6 +47,13 @@ public class HsOfficeCoopSharesTransactionEntity implements Stringifyable, HasUu
     @Enumerated(EnumType.STRING)
     private HsOfficeCoopSharesTransactionType transactionType;
 
+    /**
+     * The signed value which directly affects the booking balance.
+     *
+     * <p>This means, that a SUBSCRIPTION is always positive, a CANCELLATION is always negative,
+     * but an ADJUSTMENT can bei either positive or negative.
+     * See {@link HsOfficeCoopSharesTransactionType} for</p> more information.
+     */
     @Column(name = "valuedate")
     private LocalDate valueDate;
 

src/main/java/net/hostsharing/hsadminng/hs/office/coopshares/HsOfficeCoopSharesTransactionType.java

@@ -1,7 +1,18 @@
 package net.hostsharing.hsadminng.hs.office.coopshares;
 
 public enum HsOfficeCoopSharesTransactionType {
-    ADJUSTMENT,     // correction of wrong bookings
-    SUBSCRIPTION,   // shares signed, e.g. with the declaration of accession, >0
-    CANCELLATION;   // shares terminated, e.g. when a membership is resigned, <0
+    /**
+     * correction of wrong bookings, with either positive or negative value
+     */
+    ADJUSTMENT,
+
+    /**
+     * shares signed, e.g. with the declaration of accession, value >0
+     */
+    SUBSCRIPTION,
+
+    /**
+     * shares terminated, e.g. when a membership is resigned, value <0
+     */
+    CANCELLATION;
 }