Gh-2947: Tidy up store properties comments (#3128)

gchq · Dec 4, 2023 · 9ff3e47 · 9ff3e47
1 parent 1505eb4
commit 9ff3e47
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/core/store/src/main/java/uk/gov/gchq/gaffer/store/StoreProperties.java b/core/store/src/main/java/uk/gov/gchq/gaffer/store/StoreProperties.java
@@ -79,15 +79,15 @@ public class StoreProperties implements Cloneable {
     public static final String ADMIN_AUTH = "gaffer.store.admin.auth";
 
     /**
-     * This is used....
-     * eg.gaffer.cache.service.class="uk.gov.gchq.gaffer.cache.impl.HashMapCacheService"
+     * This is used to set the cache implementation for all caches
+     * e.g. gaffer.cache.service.class="uk.gov.gchq.gaffer.cache.impl.HashMapCacheService"
      */
     public static final String CACHE_SERVICE_CLASS = CacheProperties.CACHE_SERVICE_CLASS;
 
     /**
-     * This is used...
+     * These are used to set the suffix for all caches or per cache
      * CASE INSENSITIVE
-     * e.g. gaffer.cache.service.name.suffix="v2"
+     * e.g. gaffer.cache.service.default.suffix="v2"
      */
     public static final String CACHE_SERVICE_DEFAULT_SUFFIX = "gaffer.cache.service.default.suffix";
     public static final String CACHE_SERVICE_NAMED_OPERATION_SUFFIX = "gaffer.cache.service.named.operation.suffix";

diff --git a/...rated-store/src/main/java/uk/gov/gchq/gaffer/federatedstore/FederatedStoreProperties.java b/...rated-store/src/main/java/uk/gov/gchq/gaffer/federatedstore/FederatedStoreProperties.java
@@ -28,14 +28,16 @@
  */
 public class FederatedStoreProperties extends StoreProperties {
     /**
-     * This is used....
-     * e.g gaffer.federatedstore.isPublicAllowed=true
+     * Controls if adding graphs with public access is allowed.
+     * True by default.
+     * e.g. gaffer.federatedstore.isPublicAllowed=true
      */
     public static final String IS_PUBLIC_ACCESS_ALLOWED = "gaffer.federatedstore.isPublicAllowed";
     public static final String IS_PUBLIC_ACCESS_ALLOWED_DEFAULT = String.valueOf(true);
     /**
-     * This is used....
-     * e.g gaffer.federatedstore.customPropertiesAuths="auth1"
+     * String containing auths for allowing users to use store properties other than those contained in a graph library.
+     * Unset by default, allowing all users to do this.
+     * e.g. gaffer.federatedstore.customPropertiesAuths="auth1"
      */
     public static final String CUSTOM_PROPERTIES_AUTHS = "gaffer.federatedstore.customPropertiesAuths";
     public static final String CUSTOM_PROPERTIES_AUTHS_DEFAULT = null;