DOC: A bit of documentation.

.gitlab-ci.yml

@@ -89,6 +89,7 @@ test:
 trigger_build:
   tags: [ docker ]
   stage: deploy
+  needs: [ test ]
   script:
     - *env
 

src/main/java/org/caosdb/datetime/FragmentDateTime.java

@@ -20,6 +20,8 @@
  *
  * ** end header
  */
+
+/** @review Daniel Hornung 2022-03-04 */
 package org.caosdb.datetime;
 
 import java.util.Objects;

src/main/java/org/caosdb/datetime/UTCDateTime.java

@@ -20,6 +20,8 @@
  *
  * ** end header
  */
+
+/** @review Daniel Hornung 2022-03-04 */
 package org.caosdb.datetime;
 
 import java.util.ArrayList;

src/main/java/org/caosdb/server/datatype/AbstractEnumValue.java

 /*
- * ** header v3.0
  * This file is a part of the CaosDB Project.
  *
  * Copyright (C) 2018 Research Group Biomedical Physics,
  * Max-Planck-Institute for Dynamics and Self-Organization Göttingen
  *
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
  * published by the Free Software Foundation, either version 3 of the
@@ -17,9 +17,9 @@
  *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program. If not, see <https://www.gnu.org/licenses/>.
- *
- * ** end header
  */
+
+/** @review Daniel Hornung 2022-03-04 */
 package org.caosdb.server.datatype;
 
 import com.google.common.base.Objects;

src/main/java/org/caosdb/server/datatype/CollectionValue.java

@@ -20,6 +20,8 @@
  *
  * ** end header
  */
+
+/** @review Daniel Hornung 2022-03-04 */
 package org.caosdb.server.datatype;
 
 import java.util.ArrayList;
@@ -81,6 +83,7 @@ public class CollectionValue implements Value, Iterable<IndexedSingleValue> {
     return list.size();
   }
 
+  /** Compares if the content is equal, regardless of the order. */
   @Override
   public boolean equals(Value val) {
     if (val instanceof CollectionValue) {

src/main/java/org/caosdb/server/datatype/ReferenceValue.java

@@ -4,8 +4,9 @@
  *
  * Copyright (C) 2018 Research Group Biomedical Physics,
  *   Max-Planck-Institute for Dynamics and Self-Organization Göttingen
- * Copyright (C) 2020 IndiScale GmbH <info@indiscale.com>
+ * Copyright (C) 2022 IndiScale GmbH <info@indiscale.com>
  * Copyright (C) 2020 Timm Fitschen <t.fitschen@indiscale.com>
+ * Copyright (C) 2022 Daniel Hornung <d.hornung@indiscale.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
@@ -22,6 +23,8 @@
  *
  * ** end header
  */
+
+/** @review Daniel Hornung 2022-03-04 */
 package org.caosdb.server.datatype;
 
 import java.util.Objects;
@@ -205,6 +208,14 @@ public class ReferenceValue implements SingleValue {
     return false;
   }
 
+  /**
+   * Test if this is equal to the other object.
+   *
+   * <p>Two references are equal, if 1) they both have IDs and their content is equal or 2) at least
+   * one does not have an ID, but their names are equal. Otherwise they are considered unequal.
+   *
+   * @param val The other object.
+   */
   @Override
   public boolean equals(Value val) {
     if (val instanceof ReferenceValue) {