Mercurial > hg > LightPIT / file diff

--- a/src/main/java/de/uapcore/lightpit/LightPITModule.java	Sat May 09 15:19:21 2020 +0200
+++ b/src/main/java/de/uapcore/lightpit/LightPITModule.java	Sat May 09 17:01:29 2020 +0200
@@ -1,8 +1,8 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
- * 
+ *
  * Copyright 2018 Mike Becker. All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
@@ -24,7 +24,7 @@
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
- * 
+ *
  */
 package de.uapcore.lightpit;
 
@@ -34,7 +34,7 @@
 
 /**
  * Contains information about a LightPIT module.
- * 
+ * <p>
  * This annotation is typically used to annotate the {@link WebServlet} which
  * implements the module's functionality.
  */
@@ -44,57 +44,59 @@
 public @interface LightPITModule {
     /**
      * Base name of the module specific resource bundle.
+     *
      * @return a base name suitable for the JSTL tag 'setBundle'.
      */
     String bundleBaseName();
-    
+
     /**
      * An array of required modules, identified by the string representation of
      * their class names.
+     *
      * @return an array of class names of required modules
      */
     String[] requires() default {};
-    
+
     /**
      * The path for this module, which will also be used for the menu entry.
-     * 
+     * <p>
      * This path must adhere to the URL pattern of the Servlet but must not
      * contain any starting or trailing slashes.
-     * 
+     *
      * @return the relative module path
      */
     String modulePath();
-    
+
     /**
      * Returns the properties key for the module name.
-     * 
+     *
      * @return the properties key
      */
     String nameKey() default "name";
-    
+
     /**
      * Returns the properties key for the module description.
-     * 
+     *
      * @return the properties key
      */
     String descKey() default "description";
-    
-    
+
+
     /**
      * Returns the properties key for the menu label.
-     * 
+     * <p>
      * Set this string to empty string, if the module should be hidden from
      * the menu.
-     * 
+     *
      * @return the properties key
      */
     String menuKey() default "menuLabel";
-    
+
     /**
      * Returns the properties key for the page title.
-     * 
+     * <p>
      * By default this is the same as the menu label.
-     * 
+     *
      * @return the properties key
      */
     String titleKey() default "menuLabel";
@@ -169,6 +171,6 @@
         public String getDescKey() {
             return descKey;
         }
-        
+
     }
 }