From 7ecb920ed040dd8189ec2df5f89b50ad4d857438 Mon Sep 17 00:00:00 2001
From: Robinson <robinson@dorkbox.com>
Date: Fri, 15 Jan 2021 02:29:04 +0100
Subject: [PATCH] Added type definitions and github links

---
 src/dorkbox/network/storage/types/ChronicleMapStore.kt | 6 +++++-
 src/dorkbox/network/storage/types/LmdbStore.kt         | 6 +++++-
 src/dorkbox/network/storage/types/MemoryStore.kt       | 3 +++
 src/dorkbox/network/storage/types/PropertyStore.kt     | 3 +++
 4 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/dorkbox/network/storage/types/ChronicleMapStore.kt b/src/dorkbox/network/storage/types/ChronicleMapStore.kt
index d9afad91..4558d69f 100644
--- a/src/dorkbox/network/storage/types/ChronicleMapStore.kt
+++ b/src/dorkbox/network/storage/types/ChronicleMapStore.kt
@@ -23,7 +23,11 @@ import net.openhft.chronicle.map.ChronicleMap
 import java.io.File
 import java.net.InetAddress
 
-
+/**
+ * Chronicle Map is a super-fast, in-memory, non-blocking, key-value store
+ *
+ * https://github.com/OpenHFT/Chronicle-Map
+ */
 class ChronicleMapStore(val dbFile: File, val logger: KLogger): GenericStore {
     companion object {
         fun type(dbFile: String) : StorageType {
diff --git a/src/dorkbox/network/storage/types/LmdbStore.kt b/src/dorkbox/network/storage/types/LmdbStore.kt
index c8428790..780c2be1 100644
--- a/src/dorkbox/network/storage/types/LmdbStore.kt
+++ b/src/dorkbox/network/storage/types/LmdbStore.kt
@@ -27,7 +27,11 @@ import org.lmdbjava.EnvFlags
 import java.io.File
 import java.net.InetAddress
 
-
+/**
+ * Lightning Memory Database
+ *
+ * https://github.com/lmdbjava/lmdbjava
+ */
 class LmdbStore(val dbFile: File, val logger: KLogger): GenericStore {
     companion object {
         fun type(dbFile: String) : StorageType {
diff --git a/src/dorkbox/network/storage/types/MemoryStore.kt b/src/dorkbox/network/storage/types/MemoryStore.kt
index 03eadd3b..c3978ac4 100644
--- a/src/dorkbox/network/storage/types/MemoryStore.kt
+++ b/src/dorkbox/network/storage/types/MemoryStore.kt
@@ -21,6 +21,9 @@ import dorkbox.network.storage.StorageType
 import mu.KLogger
 import org.agrona.collections.Object2ObjectHashMap
 
+/**
+ * In-Memory store
+ */
 object MemoryStore {
     fun type() = object : StorageType {
         override fun create(logger: KLogger): SettingsStore {
diff --git a/src/dorkbox/network/storage/types/PropertyStore.kt b/src/dorkbox/network/storage/types/PropertyStore.kt
index c378f8dc..d03acb4f 100644
--- a/src/dorkbox/network/storage/types/PropertyStore.kt
+++ b/src/dorkbox/network/storage/types/PropertyStore.kt
@@ -30,6 +30,9 @@ import java.io.IOException
 import java.net.InetAddress
 import java.util.*
 
+/**
+ * Java property files
+ */
 class PropertyStore(val dbFile: File, val logger: KLogger): GenericStore {
     companion object {
         fun type(dbFile: String) : StorageType {