From 6d9a9464d81b52503ca9a42196aabf65a3ec979f Mon Sep 17 00:00:00 2001
From: Robert von Burg <eitch@eitchnet.ch>
Date: Tue, 29 Jan 2019 14:41:51 +0100
Subject: [PATCH] [Minor] Added JavaDoc to Parameter.compareTo()

---
 .../li/strolch/model/parameter/AbstractParameter.java     | 8 ++++++++
 .../main/java/li/strolch/model/parameter/Parameter.java   | 8 ++++++++
 2 files changed, 16 insertions(+)

diff --git a/li.strolch.model/src/main/java/li/strolch/model/parameter/AbstractParameter.java b/li.strolch.model/src/main/java/li/strolch/model/parameter/AbstractParameter.java
index 6d23bf569..54fd800ac 100644
--- a/li.strolch.model/src/main/java/li/strolch/model/parameter/AbstractParameter.java
+++ b/li.strolch.model/src/main/java/li/strolch/model/parameter/AbstractParameter.java
@@ -198,6 +198,14 @@ public abstract class AbstractParameter<T> extends AbstractStrolchElement implem
 		return builder.toString();
 	}
 
+	/**
+	 * Compares the value of the given parameter to this parameter
+	 *
+	 * @param otherParam
+	 * 		the parameter for which the value is to be compared to
+	 *
+	 * @return the {@link Comparable#compareTo(Object)} result
+	 */
 	@Override
 	public abstract int compareTo(Parameter<?> otherParam);
 }
diff --git a/li.strolch.model/src/main/java/li/strolch/model/parameter/Parameter.java b/li.strolch.model/src/main/java/li/strolch/model/parameter/Parameter.java
index 3cb1bb921..bf3e49444 100644
--- a/li.strolch.model/src/main/java/li/strolch/model/parameter/Parameter.java
+++ b/li.strolch.model/src/main/java/li/strolch/model/parameter/Parameter.java
@@ -185,6 +185,14 @@ public interface Parameter<T> extends StrolchElement, Comparable<Parameter<?>> {
 	@Override
 	boolean equals(Object obj);
 
+	/**
+	 * Compares the value of the given parameter to this parameter
+	 *
+	 * @param o
+	 * 		the parameter for which the value is to be compared to
+	 *
+	 * @return the {@link Comparable#compareTo(Object)} result
+	 */
 	@Override
 	int compareTo(Parameter<?> o);