svn commit: r1733290 - in /sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc: core/impl/ core/impl/servlet/ jmx/impl/ util/

[bd...@apache.org]

Author: bdelacretaz
Date: Wed Mar  2 13:51:43 2016
New Revision: 1733290

URL: http://svn.apache.org/viewvc?rev=1733290&view=rev
Log:
Fix a number of javadoc errors

Modified:
    sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/JmxScriptBindingsProvider.java
    sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/servlet/HealthCheckExecutorServlet.java
    sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/jmx/impl/HealthCheckMBeanCreator.java
    sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java

Modified: sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/JmxScriptBindingsProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/JmxScriptBindingsProvider.java?rev=1733290&r1=1733289&r2=1733290&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/JmxScriptBindingsProvider.java (original)
+++ sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/JmxScriptBindingsProvider.java Wed Mar  2 13:51:43 2016
@@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory;
 
 /** The JmxBinding is meant to be bound as "jmx" global variables
  *  in scripted rules, to allow for writing scripted expressions
- *  like jmx.attribute("java.lang:type=ClassLoading", "LoadedClassCount") > 100
+ *  like jmx.attribute("java.lang:type=ClassLoading", "LoadedClassCount") > 100
  */
 @Component
 @Service

Modified: sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/servlet/HealthCheckExecutorServlet.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/servlet/HealthCheckExecutorServlet.java?rev=1733290&r1=1733289&r2=1733290&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/servlet/HealthCheckExecutorServlet.java (original)
+++ sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/core/impl/servlet/HealthCheckExecutorServlet.java Wed Mar  2 13:51:43 2016
@@ -49,19 +49,22 @@ import org.osgi.service.http.HttpService
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/** Servlet that triggers the health check executor to return results via http. <br/>
- * <br/>
- * Parameters:<br/>
- * <br/>
- * tags: The health check tags to take into account<br/>
- * format: html|json|jsonp<br/>
- * includeDebug: If true, debug messages from result log are included.<br/>
- * callback: For jsonp, the JS callback function name (defaults to "processHealthCheckResults")<br/>
- * httpStatus: health check status to http status mapping in format httpStatus=WARN:418,CRITICAL:503,HEALTH_CHECK_ERROR:500. 
- * For omitted health check status values the next best code will be used (e.g. for httpStatus=CRITICAL:503 a result WARN will 
- * return 200, CRITICAL 503 and HEALTH_CHECK_ERROR also 503). By default all requests answer with an http status of 200. 
- * Useful in combination with load balancers.<br/>
+/** Servlet that triggers the health check executor to return results via http. 
  * 
+ * Parameters:
+ * <ul>
+ * <li>tags: The health check tags to take into account
+ * <li>format: html|json|jsonp
+ * <li>includeDebug: If true, debug messages from result log are included.
+ * <li>callback: For jsonp, the JS callback function name (defaults to "processHealthCheckResults")
+ * <li>httpStatus: health check status to http status mapping in format httpStatus=WARN:418,CRITICAL:503,HEALTH_CHECK_ERROR:500.
+ * </ul>
+ *  
+ * For omitted health check status values the next best code will be used (e.g. for httpStatus=CRITICAL:503 a result WARN will 
+ * return 200, CRITICAL 503 and HEALTH_CHECK_ERROR also 503). By default all requests answer with an http status of 200.
+ * <p> 
+ * Useful in combination with load balancers.
+ * <p>
  * NOTE: This servlet registers directly (low-level) at the HttpService and is not processed by sling (better performance, fewer dependencies, no authentication required, 503 can be sent without the progress tracker information). */
 @Service
 @Component(label = "Health Check Executor Servlet",

Modified: sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/jmx/impl/HealthCheckMBeanCreator.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/jmx/impl/HealthCheckMBeanCreator.java?rev=1733290&r1=1733289&r2=1733290&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/jmx/impl/HealthCheckMBeanCreator.java (original)
+++ sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/jmx/impl/HealthCheckMBeanCreator.java Wed Mar  2 13:51:43 2016
@@ -41,7 +41,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Creates an {@link HealthCheckMbean} for every {@link HealthCheckMBean} service
+ * Creates an {@link HealthCheckMBean} for every {@link HealthCheckMBean} service
  *
  */
 @Component

Modified: sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java?rev=1733290&r1=1733289&r2=1733290&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java (original)
+++ sling/trunk/bundles/extensions/healthcheck/core/src/main/java/org/apache/sling/hc/util/SimpleConstraintChecker.java Wed Mar  2 13:51:43 2016
@@ -21,8 +21,8 @@ import org.apache.sling.hc.api.Result;
 import org.apache.sling.hc.api.ResultLog;
 
 /** Simple check of numeric values against expressions
- *  like < N, > N, between two values etc.
- *  See  {@link SimpleConstraintCheckerTest} for examples.
+ *  like &lt; N, &gt; N, between two values etc.
+ *  See the SimpleConstraintCheckerTest for examples.
  */
 public class SimpleConstraintChecker {