From e8606e66921773968d50c97e7c15ccc4a3d2beea Mon Sep 17 00:00:00 2001
From: Gerald Unterrainer <gerald.unterrainer@cms-building.at>
Date: Mon, 12 Jul 2021 13:53:36 +0200
Subject: [PATCH] add comments #minor

---
 .../unterrainer/commons/jreutils/collections/DataMap.java     | 3 +++
 .../unterrainer/commons/jreutils/collections/DataQueue.java   | 3 +++
 .../unterrainer/commons/jreutils/collections/DataTable.java   | 4 ++++
 .../commons/jreutils/collections/SizeLimitedHashMap.java      | 4 +++-
 4 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/src/main/java/info/unterrainer/commons/jreutils/collections/DataMap.java b/src/main/java/info/unterrainer/commons/jreutils/collections/DataMap.java
index f4ea5d2..f83c802 100644
--- a/src/main/java/info/unterrainer/commons/jreutils/collections/DataMap.java
+++ b/src/main/java/info/unterrainer/commons/jreutils/collections/DataMap.java
@@ -8,6 +8,9 @@
 
 import lombok.NoArgsConstructor;
 
+/**
+ * A synchronized, size-limited hash-map.
+ */
 @NoArgsConstructor
 public class DataMap<K, V> {
 
diff --git a/src/main/java/info/unterrainer/commons/jreutils/collections/DataQueue.java b/src/main/java/info/unterrainer/commons/jreutils/collections/DataQueue.java
index e928fcc..10f1218 100644
--- a/src/main/java/info/unterrainer/commons/jreutils/collections/DataQueue.java
+++ b/src/main/java/info/unterrainer/commons/jreutils/collections/DataQueue.java
@@ -6,6 +6,9 @@
 
 import org.apache.commons.collections4.queue.CircularFifoQueue;
 
+/**
+ * A synchronized, size-limited FIFO-queue.
+ */
 public class DataQueue<T> {
 
 	private CircularFifoQueue<T> queue;
diff --git a/src/main/java/info/unterrainer/commons/jreutils/collections/DataTable.java b/src/main/java/info/unterrainer/commons/jreutils/collections/DataTable.java
index 6b6765f..535b90b 100644
--- a/src/main/java/info/unterrainer/commons/jreutils/collections/DataTable.java
+++ b/src/main/java/info/unterrainer/commons/jreutils/collections/DataTable.java
@@ -9,6 +9,10 @@
 import lombok.Getter;
 import lombok.experimental.Accessors;
 
+/**
+ * A synchronized data-structure acting as a table. You may create indexes for
+ * various columns of this table.
+ */
 @Accessors(fluent = true)
 public class DataTable<T> {
 
diff --git a/src/main/java/info/unterrainer/commons/jreutils/collections/SizeLimitedHashMap.java b/src/main/java/info/unterrainer/commons/jreutils/collections/SizeLimitedHashMap.java
index 7825b21..b094666 100644
--- a/src/main/java/info/unterrainer/commons/jreutils/collections/SizeLimitedHashMap.java
+++ b/src/main/java/info/unterrainer/commons/jreutils/collections/SizeLimitedHashMap.java
@@ -1,9 +1,11 @@
 package info.unterrainer.commons.jreutils.collections;
 
-
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+/**
+ * A size-limited hash-map.
+ */
 public class SizeLimitedHashMap<K, V> extends LinkedHashMap<K, V> {
 	private static final long serialVersionUID = 6994714918898609875L;