This is an automated email from the ASF dual-hosted git repository.
ghenzler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/felix-dev.git
The following commit(s) were added to refs/heads/master by this push:
new bf9708b javadoc fixes
bf9708b is described below
commit bf9708b7380e7f68af4b32a0f5d5de15497d8ccc
Author: georg.henzler <[email protected]>
AuthorDate: Thu Dec 23 14:03:24 2021 +0100
javadoc fixes
---
.../felix/hc/core/impl/monitor/HealthCheckMonitor.java | 4 +---
.../impl/scheduling/cron/embedded/EmbeddedCronParser.java | 13 +++++--------
.../impl/scheduling/cron/quartz/QuartzCronScheduler.java | 14 +++++++-------
.../apache/felix/hc/core/impl/util/HealthCheckFilter.java | 7 ++++---
4 files changed, 17 insertions(+), 21 deletions(-)
diff --git
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/monitor/HealthCheckMonitor.java
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/monitor/HealthCheckMonitor.java
index 17bd1d8..2a730a5 100644
---
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/monitor/HealthCheckMonitor.java
+++
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/monitor/HealthCheckMonitor.java
@@ -61,14 +61,12 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Monitors health check tags and/or names and depending on configuration:
- * <p>
+ * <p>Monitors health check tags and/or names and depending on
configuration:</p>
* <ul>
* <li>Activates the condition marker services {@link SystemReady},
* {@link Healthy}, {@link Unhealthy}</li>
* <li>Sends OSGi events</li>
* </ul>
- * <p>
*
*/
@Component(immediate = true, configurationPolicy = ConfigurationPolicy.REQUIRE)
diff --git
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/embedded/EmbeddedCronParser.java
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/embedded/EmbeddedCronParser.java
index a82bf4b..ddec1e3 100644
---
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/embedded/EmbeddedCronParser.java
+++
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/embedded/EmbeddedCronParser.java
@@ -29,14 +29,11 @@ import java.util.regex.Pattern;
/**
* Used to parse cron expressions.
- * <p>
- *
- * The pattern comprises a list of six single space-separated fields: second,
- * minute, hour, day, month, weekday. <br/>
- * Month and weekday names can be given as the first three letters of the
- * English names.
- * <p/>
- * <p>
+ * <p>The pattern comprises a list of six single space-separated fields:
second,
+ * minute, hour, day, month, weekday. </p>
+ * <p>Month and weekday names can be given as the first three letters of the
+ * English names.</p>
+ * <br>
* Examples:
* <ul>
* <li>"0 0 * * * *" = the top of every hour of every day.</li>
diff --git
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/quartz/QuartzCronScheduler.java
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/quartz/QuartzCronScheduler.java
index 8033984..93ff9e8 100644
---
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/quartz/QuartzCronScheduler.java
+++
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/scheduling/cron/quartz/QuartzCronScheduler.java
@@ -70,44 +70,44 @@ public class QuartzCronScheduler {
this.healthCheckExecutorThreadPool = healthCheckExecutorThreadPool;
}
- /** @see org.quartz.spi.QuartzThreadPool#getPoolSize() */
+ /** see org.quartz.spi.QuartzThreadPool#getPoolSize() */
@Override
public int getPoolSize() {
return healthCheckExecutorThreadPool.getPoolSize();
}
- /** @see org.quartz.spi.QuartzThreadPool#initialize() */
+ /** see org.quartz.spi.QuartzThreadPool#initialize() */
@Override
public void initialize() {
// nothing to do
}
- /** @see org.quartz.spi.ThreadPool#setInstanceId(java.lang.String) */
+ /** see org.quartz.spi.ThreadPool#setInstanceId(java.lang.String) */
@Override
public void setInstanceId(final String id) {
// we ignore this
}
- /** @see org.quartz.spi.ThreadPool#setInstanceName(java.lang.String) */
+ /** see org.quartz.spi.ThreadPool#setInstanceName(java.lang.String) */
@Override
public void setInstanceName(final String name) {
// we ignore this
}
- /** @see
org.quartz.spi.QuartzThreadPool#runInThread(java.lang.Runnable) */
+ /** see
org.quartz.spi.QuartzThreadPool#runInThread(java.lang.Runnable) */
@Override
public boolean runInThread(final Runnable job) {
healthCheckExecutorThreadPool.execute(job);
return true;
}
- /** @see org.quartz.spi.ThreadPool#blockForAvailableThreads() */
+ /** see org.quartz.spi.ThreadPool#blockForAvailableThreads() */
@Override
public int blockForAvailableThreads() {
return
healthCheckExecutorThreadPool.getMaxCurrentlyAvailableThreads();
}
- /** @see org.quartz.spi.QuartzThreadPool#shutdown(boolean) */
+ /** see org.quartz.spi.QuartzThreadPool#shutdown(boolean) */
@Override
public void shutdown(final boolean waitForJobsToComplete) {
// this executor is bound to the SCR lifecycle of
HealthCheckExecutorThreadPool
diff --git
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/util/HealthCheckFilter.java
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/util/HealthCheckFilter.java
index a3f3092..22f09d8 100644
---
a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/util/HealthCheckFilter.java
+++
b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/util/HealthCheckFilter.java
@@ -27,8 +27,7 @@ import org.osgi.framework.ServiceReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/** Select from available {@link HealthCheck} services. Once this filter
object and the returned health check services are no longer be used
- * {@link #dispose()} should be called, to free the service references.
+/** Select from available {@link HealthCheck} services.
*
* This class is not thread safe and instances shouldn't be used concurrently
from different threads. */
public class HealthCheckFilter {
@@ -41,7 +40,9 @@ public class HealthCheckFilter {
private final BundleContext bundleContext;
- /** Create a new filter object */
+ /** Create a new filter object
+ *
+ * @param bc bundle context*/
public HealthCheckFilter(final BundleContext bc) {
bundleContext = bc;
}
