[issue 114] - Adding Javadoc to the provisioner classes

Intersmash · Dec 11, 2023 · 5037f6b · 5037f6b
1 parent f4798e2
commit 5037f6b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/...rg/jboss/intersmash/tools/provision/openshift/PostgreSQLTemplateOpenShiftProvisioner.java b/...rg/jboss/intersmash/tools/provision/openshift/PostgreSQLTemplateOpenShiftProvisioner.java
@@ -17,6 +17,11 @@
 import io.fabric8.openshift.api.model.Template;
 import lombok.extern.slf4j.Slf4j;
 
+/**
+ * Provisions PostgreSql on OpenShift via PostgreSql template available on OpenShift and based on a
+ * {@link PostgreSQLTemplateOpenShiftApplication} concrete implementation.
+ *
+ */
 @Slf4j
 public class PostgreSQLTemplateOpenShiftProvisioner implements OpenShiftProvisioner<PostgreSQLTemplateOpenShiftApplication> {
 	private FailFastCheck ffCheck = () -> false;

diff --git a/...s/intersmash/tools/provision/openshift/PostgreSQLTemplateOpenShiftProvisionerFactory.java b/...s/intersmash/tools/provision/openshift/PostgreSQLTemplateOpenShiftProvisionerFactory.java
@@ -6,6 +6,10 @@
 
 import lombok.extern.slf4j.Slf4j;
 
+/**
+ * Provides logic to obtain a {@link PostgreSQLTemplateOpenShiftProvisioner} instance that is initialized with a
+ * given {@link PostgreSQLTemplateOpenShiftApplication} instance.
+ */
 @Slf4j
 public class PostgreSQLTemplateOpenShiftProvisionerFactory
 		implements ProvisionerFactory<PostgreSQLTemplateOpenShiftProvisioner> {