Skip to content
Snippets Groups Projects
Verified Commit d69d2598 authored by Timm Fitschen's avatar Timm Fitschen
Browse files

REVIEW: update some docstrings

parent 10199302
Branches
Tags
1 merge request!21Release v0.4.0
...@@ -68,7 +68,7 @@ MYSQL_USER_NAME=caosdb ...@@ -68,7 +68,7 @@ MYSQL_USER_NAME=caosdb
# Password for the user # Password for the user
MYSQL_USER_PASSWORD=caosdb MYSQL_USER_PASSWORD=caosdb
# Schema of mysql procedures and tables which is required by this CaosDB instance # 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
# -------------------------------------------------- # --------------------------------------------------
......
...@@ -40,18 +40,18 @@ import org.caosdb.server.utils.Initialization; ...@@ -40,18 +40,18 @@ import org.caosdb.server.utils.Initialization;
import org.caosdb.server.utils.Releasable; import org.caosdb.server.utils.Releasable;
/** /**
* Acquire and release read access. DatabaseMonitor uses this class for managing access to entities * Acquire and release read access. {@link DatabaseAccessManager} uses this class for managing
* during processing updates, inserts, deletions and retrievals. Read access will be granted * access to the back-end during processing updates, inserts, deletions and retrievals. Read access
* immediately for every thread that requests it, unless a thread requests that read access be * will be granted immediately for every thread that requests it, unless a thread requests that read
* blocked (usually by requesting write access). If this happens, all threads that already have read * access be blocked (usually by requesting write access). If this happens, all threads that already
* access will proceed and release their read access as usual but no NEW read permits will be * have read access will proceed and release their read access as usual but no NEW read permits will
* granted. * be granted.
* *
* <p>This is a blockable {@link Semaphore}. Any number of threads may acquire a permit unless it is * <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 * blocked. The blocking thread (requesting a {@link WriteAccessLock}) waits until all threads have
* released their permits. * released their permits.
* *
* @author Timm Fitschen * @author Timm Fitschen <t.fitschen@indiscale.com>
*/ */
class ReadAccessSemaphore extends Semaphore implements Releasable { class ReadAccessSemaphore extends Semaphore implements Releasable {
......
...@@ -64,9 +64,7 @@ import org.caosdb.server.utils.ServerMessages; ...@@ -64,9 +64,7 @@ import org.caosdb.server.utils.ServerMessages;
* BackendTransaction}s for each entity, and handles exceptions, roll-back (if necessary) and clean * BackendTransaction}s for each entity, and handles exceptions, roll-back (if necessary) and clean
* up afterwards. * 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> public class WriteTransaction extends Transaction<WritableContainer>
implements WriteTransactionInterface { implements WriteTransactionInterface {
......
...@@ -42,14 +42,8 @@ package org.caosdb.server.utils; ...@@ -42,14 +42,8 @@ package org.caosdb.server.utils;
* <li>VALID - This instance has a final ID and has been synchronized with the database. * <li>VALID - This instance has a final ID and has been synchronized with the database.
* </ul> * </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 { public enum EntityStatus {
IGNORE, IGNORE,
UNQUALIFIED, UNQUALIFIED,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment