dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 20337
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Thu 2015-09-24 09:15:17 +0200
message:
  Code style
modified:
  dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/StaticContentController.java


--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk

Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription

=== modified file 'dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/StaticContentController.java'
--- dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/StaticContentController.java	2015-09-24 07:09:18 +0000
+++ dhis-2/dhis-web/dhis-web-api/src/main/java/org/hisp/dhis/webapi/controller/StaticContentController.java	2015-09-24 07:15:17 +0000
@@ -52,8 +52,9 @@
 
 /**
  * Serves and uploads custom images(PNG) for the logo on the frontpage (logo_front)
- * and for the logo on the top banner (logo_banner)
- * Created by Stian Sandvold on 10.09.2015.
+ * and for the logo on the top banner (logo_banner).
+ * 
+ * @author Stian Sandvold
  */
 @Controller
 @RequestMapping( "/staticContent" )
@@ -70,11 +71,11 @@
         put( "logo_front", SystemSettingManager.KEY_USE_CUSTOM_LOGO_FRONT ).build();
 
     /**
-     * Serves a png associated with the key. if custom logo is not used, the request will redirect to the default
-     * logos.
+     * Serves a PNG associated with the key. if custom logo is not used, the 
+     * request will redirect to the default logos.
      *
-     * @param key      key associated with the file\image
-     * @param response the response associated with the request
+     * @param key key associated with the file\image.
+     * @param response the response associated with the request.
      * @throws WebMessageException
      */
     @RequestMapping( value = "/{key}", method = RequestMethod.GET )
@@ -124,10 +125,10 @@
     }
 
     /**
-     * Uploads pngs based on a key. only accepts png and whitelisted keys
+     * Uploads PNG images based on a key. Only accepts PNG and white listed keys.
      *
-     * @param key  to associate with the image
-     * @param file associated with the key
+     * @param key  to associate with the image.
+     * @param file associated with the key.
      * @throws WebMessageException
      * @throws IOException
      */
@@ -150,7 +151,7 @@
                 WebMessageUtils.badRequest( "This media format is not yet supported" ) );
         }
 
-        // Only keys in the whitelist is accepted at the current time
+        // Only keys in the white list is accepted at the current time
         
         if ( !KEY_WHITELIST_MAP.containsKey( key ) )
         {
@@ -173,10 +174,10 @@
     }
 
     /**
-     * returns the relative url of the default logo for a given key.
+     * Returns the relative url of the default logo for a given key.
      *
-     * @param key the key associated with the logo
-     * @return the relative url of the logo
+     * @param key the key associated with the logo. 
+     * @return the relative url of the logo.
      */
     private String getDefaultLogoUrl( String key )
     {