From d69d25984624986814ae03075e0f8356d5f289b1 Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Fri, 12 Feb 2021 21:30:42 +0100
Subject: [PATCH] REVIEW: update some docstrings
---
conf/core/server.conf | 2 +-
.../server/database/DatabaseAccessManager.java | 14 +++++++-------
.../server/transaction/WriteTransaction.java | 4 +---
.../java/org/caosdb/server/utils/EntityStatus.java | 8 +-------
4 files changed, 10 insertions(+), 18 deletions(-)
diff --git a/conf/core/server.conf b/conf/core/server.conf
index 039284de..ab5d1fb0 100644
--- a/conf/core/server.conf
+++ b/conf/core/server.conf
@@ -68,7 +68,7 @@ MYSQL_USER_NAME=caosdb
# Password for the user
MYSQL_USER_PASSWORD=caosdb
# Schema of mysql procedures and tables which is required by this CaosDB instance
-MYSQL_SCHEMA_VERSION=v4.0.0-rc2
+MYSQL_SCHEMA_VERSION=v4.0.0
# --------------------------------------------------
diff --git a/src/main/java/org/caosdb/server/database/DatabaseAccessManager.java b/src/main/java/org/caosdb/server/database/DatabaseAccessManager.java
index 72710daf..196a9fb2 100644
--- a/src/main/java/org/caosdb/server/database/DatabaseAccessManager.java
+++ b/src/main/java/org/caosdb/server/database/DatabaseAccessManager.java
@@ -40,18 +40,18 @@ import org.caosdb.server.utils.Initialization;
import org.caosdb.server.utils.Releasable;
/**
- * Acquire and release read access. DatabaseMonitor uses this class for managing access to entities
- * during processing updates, inserts, deletions and retrievals. Read access will be granted
- * immediately for every thread that requests it, unless a thread requests that read access be
- * blocked (usually by requesting write access). If this happens, all threads that already have read
- * access will proceed and release their read access as usual but no NEW read permits will be
- * granted.
+ * Acquire and release read access. {@link DatabaseAccessManager} uses this class for managing
+ * access to the back-end during processing updates, inserts, deletions and retrievals. Read access
+ * will be granted immediately for every thread that requests it, unless a thread requests that read
+ * access be blocked (usually by requesting write access). If this happens, all threads that already
+ * have read access will proceed and release their read access as usual but no NEW read permits will
+ * be granted.
*
* <p>This is a blockable {@link Semaphore}. Any number of threads may acquire a permit unless it is
* blocked. The blocking thread (requesting a {@link WriteAccessLock}) waits until all threads have
* released their permits.
*
- * @author Timm Fitschen
+ * @author Timm Fitschen <t.fitschen@indiscale.com>
*/
class ReadAccessSemaphore extends Semaphore implements Releasable {
diff --git a/src/main/java/org/caosdb/server/transaction/WriteTransaction.java b/src/main/java/org/caosdb/server/transaction/WriteTransaction.java
index 0f1fd21b..05ca0428 100644
--- a/src/main/java/org/caosdb/server/transaction/WriteTransaction.java
+++ b/src/main/java/org/caosdb/server/transaction/WriteTransaction.java
@@ -64,9 +64,7 @@ import org.caosdb.server.utils.ServerMessages;
* BackendTransaction}s for each entity, and handles exceptions, roll-back (if necessary) and clean
* up afterwards.
*
- * <p>It initializes and runs the schedule of jobs which
- *
- * @author Timm Fitschen (t.fitschen@indiscale.com)
+ * @author Timm Fitschen <t.fitschen@indiscale.com>
*/
public class WriteTransaction extends Transaction<WritableContainer>
implements WriteTransactionInterface {
diff --git a/src/main/java/org/caosdb/server/utils/EntityStatus.java b/src/main/java/org/caosdb/server/utils/EntityStatus.java
index 6687622c..d6658ef1 100644
--- a/src/main/java/org/caosdb/server/utils/EntityStatus.java
+++ b/src/main/java/org/caosdb/server/utils/EntityStatus.java
@@ -42,14 +42,8 @@ package org.caosdb.server.utils;
* <li>VALID - This instance has a final ID and has been synchronized with the database.
* </ul>
*
- * @author Timm Fitschen
+ * @author Timm Fitschen <t.fitschen@indiscale.com>
*/
-
-// TODO Can these comment lines be removed?
-// * <li>WRITTEN - This instance has been written successfully to the database. It has a final ID.
-// * // * <li>CORRUPT - This instance has
-// * been retrieved from the database, but though something turned out to be wrong with it.
-
public enum EntityStatus {
IGNORE,
UNQUALIFIED,
--
GitLab