From 0fc5f9ea6d0a56b286cc7d08a48bd0ca0bac9b7e Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Fri, 8 Dec 2023 15:05:37 +0100
Subject: [PATCH] DOC: add class docs for RetrieveEntity
---
.../java/org/caosdb/server/entity/RetrieveEntity.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/caosdb/server/entity/RetrieveEntity.java b/src/main/java/org/caosdb/server/entity/RetrieveEntity.java
index 69df103a..e1b9e8c0 100644
--- a/src/main/java/org/caosdb/server/entity/RetrieveEntity.java
+++ b/src/main/java/org/caosdb/server/entity/RetrieveEntity.java
@@ -24,8 +24,14 @@
*/
package org.caosdb.server.entity;
-// TODO document the use of this class; it seems to exist of only constructors
-
+/**
+ * Entity which is to be retrieved (i.e. read-only).
+ *
+ * <p>This class only exposes those constructors which are necessary for Entity which are to be
+ * retrieved (e.g. Entity(id)) and hide the others (e.g. Entity(XML-Represenation)).
+ *
+ * @author Timm Fitschen <t.fitschen@indiscale.com>
+ */
public class RetrieveEntity extends Entity {
public RetrieveEntity() {
--
GitLab