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

jbonofre pushed a commit to branch karaf-4.1.x
in repository https://gitbox.apache.org/repos/asf/karaf.git


The following commit(s) were added to refs/heads/karaf-4.1.x by this push:
     new 3c7e8bc  Fix javadoc
3c7e8bc is described below

commit 3c7e8bcd7b720908335bb30833e056178bc66a2f
Author: Jean-Baptiste Onofré <[email protected]>
AuthorDate: Fri Dec 15 15:13:22 2017 +0100

    Fix javadoc
---
 .../karaf/features/command/completers/AllFeatureCompleter.java   | 2 +-
 .../features/command/completers/RequiredFeatureCompleter.java    | 2 +-
 .../apache/karaf/jaas/modules/ldap/ManagedSSLSocketFactory.java  | 6 ------
 .../karaf/jaas/modules/properties/DigestPasswordLoginModule.java | 1 -
 .../karaf/log/core/internal/layout/AbsoluteTimeDateFormat.java   | 9 +++------
 .../org/apache/karaf/log/core/internal/layout/PatternParser.java | 3 +--
 .../org/apache/karaf/profile/versioning/ComparableVersion.java   | 3 +--
 .../src/main/java/org/apache/karaf/scheduler/Scheduler.java      | 6 ++----
 .../java/org/apache/karaf/scheduler/core/QuartzScheduler.java    | 4 ++--
 .../apache/karaf/shell/console/completer/CommandsCompleter.java  | 2 +-
 10 files changed, 12 insertions(+), 26 deletions(-)

diff --git 
a/features/command/src/main/java/org/apache/karaf/features/command/completers/AllFeatureCompleter.java
 
b/features/command/src/main/java/org/apache/karaf/features/command/completers/AllFeatureCompleter.java
index 7444b95..771af10 100644
--- 
a/features/command/src/main/java/org/apache/karaf/features/command/completers/AllFeatureCompleter.java
+++ 
b/features/command/src/main/java/org/apache/karaf/features/command/completers/AllFeatureCompleter.java
@@ -20,7 +20,7 @@ import org.apache.karaf.features.Feature;
 import org.apache.karaf.shell.api.action.lifecycle.Service;
 
 /**
- * {@link org.apache.karaf.shell.console.Completer} for available features.
+ * {@link FeatureCompleterSupport} completing all features.
  */
 @Service
 public class AllFeatureCompleter extends FeatureCompleterSupport {
diff --git 
a/features/command/src/main/java/org/apache/karaf/features/command/completers/RequiredFeatureCompleter.java
 
b/features/command/src/main/java/org/apache/karaf/features/command/completers/RequiredFeatureCompleter.java
index a51f75f..cf0618f 100644
--- 
a/features/command/src/main/java/org/apache/karaf/features/command/completers/RequiredFeatureCompleter.java
+++ 
b/features/command/src/main/java/org/apache/karaf/features/command/completers/RequiredFeatureCompleter.java
@@ -20,7 +20,7 @@ import org.apache.karaf.features.Feature;
 import org.apache.karaf.shell.api.action.lifecycle.Service;
 
 /**
- * {@link org.apache.karaf.shell.console.Completer} for installed features.
+ * {@link FeatureCompleterSupport} for installed features.
  */
 @Service
 public class RequiredFeatureCompleter extends FeatureCompleterSupport {
diff --git 
a/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/ldap/ManagedSSLSocketFactory.java
 
b/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/ldap/ManagedSSLSocketFactory.java
index 3796068..9115208 100644
--- 
a/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/ldap/ManagedSSLSocketFactory.java
+++ 
b/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/ldap/ManagedSSLSocketFactory.java
@@ -73,12 +73,6 @@ public class ManagedSSLSocketFactory extends 
SSLSocketFactory implements Compara
         return delegate.createSocket(address, port, localAddress, localPort);
     }
 
-    /**
-     * For 
com.sun.jndi.ldap.ClientId#invokeComparator(com.sun.jndi.ldap.ClientId, 
com.sun.jndi.ldap.ClientId)
-     * @param f1
-     * @param f2
-     * @return
-     */
     public int compare(Object f1, Object f2) {
         if (f1 == null && f2 == null) {
             return 0;
diff --git 
a/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/properties/DigestPasswordLoginModule.java
 
b/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/properties/DigestPasswordLoginModule.java
index ffbd9cc..0b17ad7 100644
--- 
a/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/properties/DigestPasswordLoginModule.java
+++ 
b/jaas/modules/src/main/java/org/apache/karaf/jaas/modules/properties/DigestPasswordLoginModule.java
@@ -102,7 +102,6 @@ public class  DigestPasswordLoginModule extends 
AbstractKarafLoginModule {
      * method is cached for efficiency.  
      * @param inputBytes the bytes to digest
      * @return the digest of the input bytes
-     * @throws WSSecurityException
      */
     public synchronized byte[] generateDigest(byte[] inputBytes) {
         try {
diff --git 
a/log/src/main/java/org/apache/karaf/log/core/internal/layout/AbsoluteTimeDateFormat.java
 
b/log/src/main/java/org/apache/karaf/log/core/internal/layout/AbsoluteTimeDateFormat.java
index 8bb3ff3..cde820c 100644
--- 
a/log/src/main/java/org/apache/karaf/log/core/internal/layout/AbsoluteTimeDateFormat.java
+++ 
b/log/src/main/java/org/apache/karaf/log/core/internal/layout/AbsoluteTimeDateFormat.java
@@ -35,21 +35,18 @@ import java.util.TimeZone;
 public class AbsoluteTimeDateFormat extends DateFormat {
 
   /**
-     String constant used to specify {@link
-     org.apache.log4j.helpers.AbsoluteTimeDateFormat} in layouts. Current
+     String constant used to specify {@link AbsoluteTimeDateFormat} in 
layouts. Current
      value is <b>ABSOLUTE</b>.  */
   public final static String ABS_TIME_DATE_FORMAT = "ABSOLUTE";
 
   /**
-     String constant used to specify {@link
-     org.apache.log4j.helpers.DateTimeDateFormat} in layouts.  Current
+     String constant used to specify {@link DateTimeDateFormat} in layouts.  
Current
      value is <b>DATE</b>.
   */
   public final static String DATE_AND_TIME_DATE_FORMAT = "DATE";
 
   /**
-     String constant used to specify {@link
-     org.apache.log4j.helpers.ISO8601DateFormat} in layouts. Current
+     String constant used to specify {@link ISO8601DateFormat} in layouts. 
Current
      value is <b>ISO8601</b>.
   */
   public final static String ISO8601_DATE_FORMAT = "ISO8601";
diff --git 
a/log/src/main/java/org/apache/karaf/log/core/internal/layout/PatternParser.java
 
b/log/src/main/java/org/apache/karaf/log/core/internal/layout/PatternParser.java
index 61f7343..3667dc4 100644
--- 
a/log/src/main/java/org/apache/karaf/log/core/internal/layout/PatternParser.java
+++ 
b/log/src/main/java/org/apache/karaf/log/core/internal/layout/PatternParser.java
@@ -30,8 +30,7 @@ import org.ops4j.pax.logging.spi.PaxLoggingEvent;
  * Copied from log4j
  */
 /**
-   Most of the work of the {@link org.apache.log4j.PatternLayout} class
-   is delegated to the PatternParser class.
+   Most of the work of the PatternLayout class is delegated to the 
PatternParser class.
 
    @since 0.8.2
 */
diff --git 
a/profile/src/main/java/org/apache/karaf/profile/versioning/ComparableVersion.java
 
b/profile/src/main/java/org/apache/karaf/profile/versioning/ComparableVersion.java
index 0362183..c8b565a 100644
--- 
a/profile/src/main/java/org/apache/karaf/profile/versioning/ComparableVersion.java
+++ 
b/profile/src/main/java/org/apache/karaf/profile/versioning/ComparableVersion.java
@@ -33,7 +33,6 @@ import java.util.Stack;
 /**
  * Generic implementation of version comparison.
  *
- * <p>
  * Features:
  * <ul>
  * <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) 
separators,</li>
@@ -54,7 +53,7 @@ import java.util.Stack;
  * Unknown qualifiers are considered after known qualifiers, with lexical 
order (always case insensitive),
  * </li>
  * <li>a hyphen usually precedes a qualifier, and is always less important 
than something preceded with a dot.</li>
- * </ul></p>
+ * </ul>
  *
  * @see <a 
href="https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning";>"Versioning"
 on Maven Wiki</a>
  * @author <a href="mailto:[email protected]";>Kenney Westerhof</a>
diff --git a/scheduler/src/main/java/org/apache/karaf/scheduler/Scheduler.java 
b/scheduler/src/main/java/org/apache/karaf/scheduler/Scheduler.java
index 7171069..8a0c9df 100644
--- a/scheduler/src/main/java/org/apache/karaf/scheduler/Scheduler.java
+++ b/scheduler/src/main/java/org/apache/karaf/scheduler/Scheduler.java
@@ -84,10 +84,8 @@ public interface Scheduler {
 
     /**
      * Update the scheduling of an existing job.
-     * @param jobName
-     * @param options
-     * @throws IllegalArgumentException
-     * @throws SchedulerError
+     * @param jobName The existing job name.
+     * @param options The new scheduling options.
      */
     void reschedule(String jobName, ScheduleOptions options) throws 
IllegalArgumentException, SchedulerError;
 
diff --git 
a/scheduler/src/main/java/org/apache/karaf/scheduler/core/QuartzScheduler.java 
b/scheduler/src/main/java/org/apache/karaf/scheduler/core/QuartzScheduler.java
index e7785a6..75c3950 100644
--- 
a/scheduler/src/main/java/org/apache/karaf/scheduler/core/QuartzScheduler.java
+++ 
b/scheduler/src/main/java/org/apache/karaf/scheduler/core/QuartzScheduler.java
@@ -196,9 +196,9 @@ public class QuartzScheduler implements Scheduler {
     }
 
     /**
-     * Schedule a job
+     * Schedule a job.
      * @see org.apache.karaf.scheduler.Scheduler#schedule(java.lang.Object, 
org.apache.karaf.scheduler.ScheduleOptions)
-     * @throws SchedulerException if the job can't be scheduled
+     * @throws SchedulerError if the job can't be scheduled
      * @throws IllegalArgumentException If the preconditions are not met
      */
     public void schedule(final Object job, final ScheduleOptions options) 
throws IllegalArgumentException, SchedulerError {
diff --git 
a/shell/console/src/main/java/org/apache/karaf/shell/console/completer/CommandsCompleter.java
 
b/shell/console/src/main/java/org/apache/karaf/shell/console/completer/CommandsCompleter.java
index ba1ffde..c55c52a 100644
--- 
a/shell/console/src/main/java/org/apache/karaf/shell/console/completer/CommandsCompleter.java
+++ 
b/shell/console/src/main/java/org/apache/karaf/shell/console/completer/CommandsCompleter.java
@@ -46,7 +46,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  * Like the {@link org.apache.karaf.shell.console.completer.CommandsCompleter} 
but does not use OSGi but is
- * instead used from the non-OSGi {@link 
org.apache.karaf.shell.console.impl.Main}
+ * instead used from the non-OSGi {@code 
org.apache.karaf.shell.console.impl.Main}
  */
 @Deprecated
 public class CommandsCompleter implements Completer {

-- 
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].

Reply via email to