From 6c6fdb8d560255b3a9168fcef9529148ed9335e7 Mon Sep 17 00:00:00 2001
From: Daniel <daniel@harvey>
Date: Mon, 22 Jul 2019 17:57:53 +0200
Subject: [PATCH] DOC: Better source code documentation.

---
 .../server/jobs/core/CheckFileStorageConsistency.java      | 7 ++++++-
 .../caosdb/server/utils/FileStorageConsistencyCheck.java   | 1 +
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/main/java/caosdb/server/jobs/core/CheckFileStorageConsistency.java b/src/main/java/caosdb/server/jobs/core/CheckFileStorageConsistency.java
index 9cee3f83..b74a0319 100644
--- a/src/main/java/caosdb/server/jobs/core/CheckFileStorageConsistency.java
+++ b/src/main/java/caosdb/server/jobs/core/CheckFileStorageConsistency.java
@@ -50,7 +50,12 @@ import org.jdom2.output.XMLOutputter;
     loadOnDefault = false,
     transaction = Retrieve.class,
     description =
-        "Invokes a consistency test of the file storage. The value is a string with a timeout (prefixed -t), a filesystem location which children are checked recursively, or a test case (prefixed -c)which can be run if the server is in debug mode.")
+        "Invokes a consistency test of the file storage. The value can have any of:\n"
+            + "  - a string with a timeout in ms (prefixed -t): `-t 120000`\n"
+            + "  - a test case which can be run if the server is in debug mode (prefixed\n"
+            + "    -c)\n"
+            + "  - a filesystem location whose children are checked recursively,\n"
+            + "    relative to the caosroot dilesystem location.\n")
 public class CheckFileStorageConsistency extends FlagJob {
 
   public static final Pattern parseArgs =
diff --git a/src/main/java/caosdb/server/utils/FileStorageConsistencyCheck.java b/src/main/java/caosdb/server/utils/FileStorageConsistencyCheck.java
index 01157a4d..c750bb4e 100644
--- a/src/main/java/caosdb/server/utils/FileStorageConsistencyCheck.java
+++ b/src/main/java/caosdb/server/utils/FileStorageConsistencyCheck.java
@@ -82,6 +82,7 @@ public class FileStorageConsistencyCheck extends Thread
         }
 
         final String path = iterator.next();
+        // FIXME this prevents all files with ".thumbnail" from being checked.
         if (path.contains(".thumbnail")) {
           continue;
         }
-- 
GitLab