Cleanup Code

Pushed-by: Rene Pfeuffer<rene.pfeuffer@cloudogu.com>
Co-authored-by: René Pfeuffer<rene.pfeuffer@cloudogu.com>

scm-annotations/src/main/java/sonia/scm/Default.java

@@ -24,12 +24,9 @@
     
 package sonia.scm;
 
-//~--- non-JDK imports --------------------------------------------------------
 
 import com.google.inject.BindingAnnotation;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -40,7 +37,6 @@ import java.lang.annotation.Target;
  * The default annotation can be used to inject the default implementation of
  * service. The annotation is mainly used to inject the ServletContext.
  *
- * @author Sebastian Sdorra
  * @since 2.0.0
  */
 @Documented

scm-annotations/src/main/java/sonia/scm/Priority.java

@@ -24,8 +24,6 @@
     
 package sonia.scm;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -34,7 +32,6 @@ import java.lang.annotation.Target;
 
 /**
  *
- * @author Sebastian Sdorra
  * @since 2.0.0
  */
 @Documented

scm-annotations/src/main/java/sonia/scm/api/v2/resources/Enrich.java

@@ -33,7 +33,6 @@ import java.lang.annotation.Target;
 /**
  * Annotation to specify the source of an enricher.
  *
- * @author Sebastian Sdorra
  * @since 2.0.0
  */
 @Documented

scm-annotations/src/main/java/sonia/scm/event/Event.java

@@ -24,12 +24,9 @@
     
 package sonia.scm.event;
 
-//~--- non-JDK imports --------------------------------------------------------
 
 import sonia.scm.plugin.PluginAnnotation;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -40,7 +37,6 @@ import java.lang.annotation.Target;
  * This annotation marks classes which are receivable over the event bus of
  * scm-manager.
  *
- * @author Sebastian Sdorra
  * @since 1.33
  */
 @Documented

scm-annotations/src/main/java/sonia/scm/filter/WebElement.java

@@ -24,12 +24,9 @@
     
 package sonia.scm.filter;
 
-//~--- non-JDK imports --------------------------------------------------------
 
 import sonia.scm.plugin.PluginAnnotation;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -40,7 +37,6 @@ import java.lang.annotation.Target;
  * Annotation to register servlets and filters. The annotation is automatically 
  * picked up by the plugin registration processor of SCM-Manager.
  *
- * @author Sebastian Sdorra
  * @since 2.0.0
  */
 @Documented
@@ -69,14 +65,11 @@ public @interface WebElement
    * Returns {@code true} if the path patterns are specified as regex patterns.
    * Default is {@code false}.
    * 
-   * @return {@code true} if the path patterns are specified as regex patterns
    */
   public boolean regex() default false;
 
   /**
    * Returns an array of init params.
-   * 
-   * @return array of init params
    */
   public WebInitParam[] initParams() default {};
 }

scm-annotations/src/main/java/sonia/scm/filter/WebInitParam.java

@@ -34,24 +34,13 @@ import java.lang.annotation.Target;
  * Init param for servlet of filter registration. This annotation can only be 
  * used with {@link WebElement}.
  *
- * @author Sebastian Sdorra
  */
 @Documented
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface WebInitParam
 {
-  /**
-   * Name of the init parameter.
-   * 
-   * @return name of init parameter
-   */
   public String name();
   
-  /**
-   * Value of the init parameter.
-   * 
-   * @return value of init parameter
-   */
   public String value();
 }

scm-annotations/src/main/java/sonia/scm/i18n/I18n.java

@@ -24,8 +24,6 @@
     
 package sonia.scm.i18n;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -36,7 +34,6 @@ import java.lang.annotation.Target;
  * The I18n annotation is used by the I18nMessages class to define the
  * resource bundle key.
  *
- * @author Sebastian Sdorra
  * @since 1.37
  */
 @Documented
@@ -46,8 +43,6 @@ public @interface I18n
 {
   /**
    * Returns the key for the resource bundle.
-   *
-   * @return resource bundle key
    */
   String value();
 }

scm-annotations/src/main/java/sonia/scm/plugin/Extension.java

@@ -24,18 +24,13 @@
     
 package sonia.scm.plugin;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- *
- * @author Sebastian Sdorra
- */
+
 @Documented
 @Target({ ElementType.TYPE })
 @PluginAnnotation("extension")

scm-annotations/src/main/java/sonia/scm/plugin/ExtensionPoint.java

@@ -30,10 +30,7 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/**
- *
- * @author Sebastian Sdorra
- */
+
 @Documented
 @Target({ ElementType.TYPE })
 @PluginAnnotation("extension-point")

scm-annotations/src/main/java/sonia/scm/plugin/PluginAnnotation.java

@@ -24,8 +24,6 @@
     
 package sonia.scm.plugin;
 
-//~--- JDK imports ------------------------------------------------------------
-
 import java.lang.annotation.Documented;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -34,7 +32,6 @@ import java.lang.annotation.Target;
 
 /**
  *
- * @author Sebastian Sdorra
  * @since 2.0.0
  */
 @Documented

scm-annotations/src/main/java/sonia/scm/search/Indexed.java

@@ -59,8 +59,6 @@ public @interface Indexed {
 
   /**
    * {@code true} if this field should be part of default query for this type of object.
-   *
-   * @return {@code true} if field is part of default query
    */
   boolean defaultQuery() default false;
 
@@ -76,7 +74,6 @@ public @interface Indexed {
   /**
    * {@code true} to search the field value for matches and returns fragments with those matches instead of the whole value.
    *
-   * @return {@code true} to return matched fragments
    */
   boolean highlighted() default false;
 
@@ -150,9 +147,6 @@ public @interface Indexed {
     }
 
     /**
-     * Returns {@code true} if the field is tokenized.
-     *
-     * @return {@code true} if tokenized
      * @see #TOKENIZED
      */
     public boolean isTokenized() {
@@ -160,19 +154,12 @@ public @interface Indexed {
     }
 
     /**
-     * Returns {@code true} if the field is searchable.
-     *
-     * @return {@code true} if searchable
      * @see #SEARCHABLE
      */
     public boolean isSearchable() {
       return searchable;
     }
 
-    /**
-     * Returns {@code true} if the field is stored.
-     * @return {@code true} if stored
-     */
     public boolean isStored() {
       return stored;
     }