Improving javadoc.

Author: staudtMarius

src/main/java/edu/ie3/simona/api/data/container/ExtInputContainer.java

@@ -86,7 +86,7 @@ public void addPrimaryValue(UUID asset, Value value) {
    * Method for adding flex option requests.
    *
    * @param receiver the uuid of the agent, that will receive the request
-   * @param sender uuid of the sender
+   * @param sender option for the uuid of the sender
    */
   public void addRequest(UUID receiver, UUID sender) {
     flexRequests.put(receiver, new FlexOptionRequest(receiver, sender));

src/main/java/edu/ie3/simona/api/data/container/ExtOutputContainer.java

@@ -23,14 +23,14 @@ public final class ExtOutputContainer implements ExtDataContainer {
   private final Optional<Long> maybeNextTick;
 
   /**
-   * Map receiver uuid to result from SIMONA.
+   * Map: receiver uuid to result from SIMONA.
    *
    * <p>ATTENTION: The time stamp of the result entities is not necessarily corresponding to the
    * tick
    */
   private final Map<UUID, ResultEntity> resultMap;
 
-  /** Map receiver uuid to {@link EmData} from SIMONA. */
+  /** Map: receiver uuid to {@link EmData} from SIMONA. */
   private final Map<UUID, EmData> emDataMap;
 
   /**

src/main/java/edu/ie3/simona/api/data/model/em/EmSetPoint.java

@@ -13,20 +13,20 @@
 import tech.units.indriya.ComparableQuantity;
 
 /**
- * Energy management set point that will be sent to SIMONA
+ * Energy management set point that will be sent to SIMONA.
  *
- * @param receiver of the message
- * @param sender of the message
- * @param power an option for the em set point
+ * @param receiver The receiver of the set point.
+ * @param sender The sender of the set point.
+ * @param power An option for the em set point.
  */
 public record EmSetPoint(UUID receiver, UUID sender, Optional<PValue> power) implements EmData {
   /**
    * Constructor for {@link EmSetPoint}.
    *
    * <p>Note: Using this constructor will signal SIMONA, that the current set point should be kept.
    *
-   * @param receiver of the set point.
-   * @param sender of the set point.
+   * @param receiver The receiver of the set point.
+   * @param sender The sender of the set point.
    */
   public EmSetPoint(UUID receiver, UUID sender) {
     this(receiver, sender, Optional.empty());
@@ -35,9 +35,9 @@ public EmSetPoint(UUID receiver, UUID sender) {
   /**
    * Constructor for {@link EmSetPoint}.
    *
-   * @param receiver of the set point
-   * @param sender of the set point
-   * @param p power value of the set point
+   * @param receiver The receiver of the set point.
+   * @param sender The sender of the set point.
+   * @param p Power value of the set point.
    */
   public EmSetPoint(UUID receiver, UUID sender, ComparableQuantity<Power> p) {
     this(receiver, sender, Optional.of(new PValue(p)));
@@ -46,9 +46,9 @@ public EmSetPoint(UUID receiver, UUID sender, ComparableQuantity<Power> p) {
   /**
    * Constructor for {@link EmSetPoint}.
    *
-   * @param receiver of the set point
-   * @param sender of the set point
-   * @param power value of the set point
+   * @param receiver The receiver of the set point.
+   * @param sender The sender of the set point.
+   * @param power value of the set point.
    */
   public EmSetPoint(UUID receiver, UUID sender, PValue power) {
     this(receiver, sender, Optional.ofNullable(power));

src/main/java/edu/ie3/simona/api/data/model/em/FlexOptionRequest.java

@@ -11,8 +11,8 @@
 /**
  * Energy management flex option request that will be sent to SIMONA.
  *
- * @param receiver of the message
- * @param sender of the request
+ * @param receiver The receiver of the request.
+ * @param sender The sender of the request.
  */
 public record FlexOptionRequest(UUID receiver, UUID sender) implements EmData {
 

src/main/java/edu/ie3/simona/api/data/model/em/FlexOptions.java

@@ -16,8 +16,8 @@
 /**
  * Flex option that will be sent to SIMONA.
  *
- * @param receiver The receiver of the message.
- * @param sender The sender of the request.
+ * @param receiver The receiver of the flex options.
+ * @param sender The sender of the flex options.
  * @param pRef Active power (might be negative, thus feed-in) that was suggested for regular usage.
  * @param pMin Minimal active power to which the sender can be reduced (might be negative, thus
  *     feed-in), that was determined by the system. Therefore, equates to lower bound of possible