(sling-org-apache-sling-jcr-repoinit) branch SLING-12262-metric-for-failures updated: add javadoc

[joerghoh]

This is an automated email from the ASF dual-hosted git repository.

joerghoh pushed a commit to branch SLING-12262-metric-for-failures
in repository 
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-jcr-repoinit.git


The following commit(s) were added to 
refs/heads/SLING-12262-metric-for-failures by this push:
     new 4dd1d62  add javadoc
4dd1d62 is described below

commit 4dd1d6214eac08bd951b05f3a1790e656901a98e
Author: Joerg Hoh <joerg...@apache.org>
AuthorDate: Sat Mar 9 17:40:41 2024 +0100

    add javadoc
---
 .../apache/sling/jcr/repoinit/impl/RepositoryInitializerFactory.java  | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git 
a/src/main/java/org/apache/sling/jcr/repoinit/impl/RepositoryInitializerFactory.java
 
b/src/main/java/org/apache/sling/jcr/repoinit/impl/RepositoryInitializerFactory.java
index 67d40c5..3db10d9 100644
--- 
a/src/main/java/org/apache/sling/jcr/repoinit/impl/RepositoryInitializerFactory.java
+++ 
b/src/main/java/org/apache/sling/jcr/repoinit/impl/RepositoryInitializerFactory.java
@@ -209,8 +209,8 @@ public class RepositoryInitializerFactory implements 
SlingRepositoryInitializer
     }
     
     /**
-     * 
-     * @return
+     * return the state of the repoinit execution usable for a simple gauge 
metric
+     * @return 1 if repoinit did not finish successfully, 0 otherwise
      */
     protected int failureStateAsMetric() {
         return aRepoInitStatementFailed ? 1 : 0;