Merge pull request #202 from shoito/fix-javadoc-in-ff4j-web

Fix JavaDoc comments in ff4j-web
ff4j · Mar 15, 2017 · 9c71f02 · 9c71f02
2 parents 66f7261 + 4e01a06
commit 9c71f02
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 23 deletions.
diff --git a/ff4j-web/src/main/java/org/ff4j/web/FF4jServlet.java b/ff4j-web/src/main/java/org/ff4j/web/FF4jServlet.java
@@ -166,8 +166,6 @@ private void initializeFF4J(ServletConfig servletConfig) {
 
     /**
      * Initialize Thymeleaf.
-     *
-     * @param servletConfig
      */
     private void initializeTemplateEngine() {
     	ClassLoaderTemplateResolver templateResolver = new ClassLoaderTemplateResolver();

diff --git a/ff4j-web/src/main/java/org/ff4j/web/bean/HomeBean.java b/ff4j-web/src/main/java/org/ff4j/web/bean/HomeBean.java
@@ -165,7 +165,7 @@ public String getUptime() {
     /**
      * Setter accessor for attribute 'uptime'.
      *
-     * @param uptime
+     * @param ff4jStartTime
      *            new value for 'uptime '
      */
     public void setUptime(long ff4jStartTime) {

diff --git a/ff4j-web/src/main/java/org/ff4j/web/controller/FeaturesController.java b/ff4j-web/src/main/java/org/ff4j/web/controller/FeaturesController.java
@@ -245,8 +245,8 @@ private void updateFeature(HttpServletRequest req, String featureId) {
      *
      * @param req
      *            current http query
-     * @param fp
-     *            current feature
+     * @param uid
+     *      unique feature identifier
      * @return instance of strategy
      */
     private FlippingStrategy buildFlippingStrategy(HttpServletRequest req, String uid) {

diff --git a/ff4j-web/src/main/java/org/ff4j/web/embedded/ConsoleRenderer.java b/ff4j-web/src/main/java/org/ff4j/web/embedded/ConsoleRenderer.java
@@ -193,9 +193,9 @@ public static void renderPage(FF4j ff4j, HttpServletRequest req, HttpServletResp
      *            http request (with parameters)
      * @param res
      *            http response (with outouput test)
-     * @param message
+     * @param msg
      *            text in the information box (blue/green/orange/red)
-     * @param messagetype
+     * @param msgType
      *            type of informatice message (info,success,warning,error)
      * @throws IOException
      *             error during populating http response
@@ -214,7 +214,7 @@ public static void renderPageMonitoring(FF4j ff4j, HttpServletRequest req, HttpS
      * 
      * @param featureName
      *            target feature name
-     * @param operationd
+     * @param operationId
      *            target operationId
      * @return
      */
@@ -227,7 +227,7 @@ public static String msg(String featureName, String operationId) {
      * 
      * @param featureName
      *            target feature name
-     * @param operationd
+     * @param operationId
      *            target operationId
      * @return
      */
@@ -238,9 +238,9 @@ public static  String renderMsgProperty(String featureName, String operationId)
     /**
      * Build info messages.
      * 
-     * @param featureName
-     *            target feature name
-     * @param operationd
+     * @param groupName
+     *            target group name
+     * @param operationId
      *            target operationId
      * @return
      */
@@ -428,8 +428,11 @@ private static final String renderAuditRows(FF4j ff4j, HttpServletRequest req) {
     /**
      * Produce the rows of the Feature Table.
      *
-     * @param currentElement
-     * @return
+     * @param ff4j
+     *            target ff4j.
+     * @param req
+     *            current http request
+     * @return string representing the list of features
      */
     private static final String renderFeatureRows(FF4j ff4j, HttpServletRequest req) {
         StringBuilder sb = new StringBuilder();
@@ -627,4 +630,4 @@ private static String loadFileAsString(String fileName) {
         return strBuilder.toString();
     }
 
-}
+}
diff --git a/ff4j-web/src/main/java/org/ff4j/web/utils/FileUtils.java b/ff4j-web/src/main/java/org/ff4j/web/utils/FileUtils.java
@@ -129,8 +129,8 @@ public final static String loadFileAsStringWithBuffer(String fileName) throws IO
 	/**
 	 * Transform inputStream into base64.
 	 *
-	 * @param image The image to encode
-	 * @param type jpeg, bmp, ...
+	 * @param fileName
+	 * 		target file name
 	 * @return encoded string
 	 */
 	public static String loadAndResizeImageAsBase64(String fileName) {
@@ -140,8 +140,8 @@ public static String loadAndResizeImageAsBase64(String fileName) {
 	/**
 	 * Transform inputStream into base64.
 	 *
-	 * @param image The image to encode
-	 * @param type jpeg, bmp, ...
+	 * @param fileName
+	 * 		target file name
 	 * @return encoded string
 	 */
 	public static byte[] loadAndResizeImageAsByteArray(String fileName) {
@@ -152,8 +152,8 @@ public static byte[] loadAndResizeImageAsByteArray(String fileName) {
 	/**
 	 * Transform inputStream into base64.
 	 *
-	 * @param image The image to encode
-	 * @param type jpeg, bmp, ...
+	 * @param fileName
+	 * 		target file name
 	 * @return encoded string
 	 * @throws FileNotFoundException 
 	 */
@@ -223,8 +223,8 @@ public static ByteArrayOutputStream loadFileAsOutputStream(String fileName)
 	/**
 	 * Transform inputStream into base64.
 	 *
-	 * @param image The image to encode
-	 * @param type jpeg, bmp, ...
+	 * @param fileName
+	 * 		target file name
 	 * @return encoded string
 	 * @throws FileNotFoundException 
 	 */