Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JavaDoc comments in ff4j-web #202

Merged
merged 1 commit into from
Mar 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions ff4j-web/src/main/java/org/ff4j/web/FF4jServlet.java
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,6 @@ private void initializeFF4J(ServletConfig servletConfig) {

/**
* Initialize Thymeleaf.
*
* @param servletConfig
*/
private void initializeTemplateEngine() {
ClassLoaderTemplateResolver templateResolver = new ClassLoaderTemplateResolver();
Expand Down
2 changes: 1 addition & 1 deletion ff4j-web/src/main/java/org/ff4j/web/bean/HomeBean.java
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
23 changes: 13 additions & 10 deletions ff4j-web/src/main/java/org/ff4j/web/embedded/ConsoleRenderer.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
*/
Expand All @@ -227,7 +227,7 @@ public static String msg(String featureName, String operationId) {
*
* @param featureName
* target feature name
* @param operationd
* @param operationId
* target operationId
* @return
*/
Expand All @@ -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
*/
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -627,4 +630,4 @@ private static String loadFileAsString(String fileName) {
return strBuilder.toString();
}

}
}
16 changes: 8 additions & 8 deletions ff4j-web/src/main/java/org/ff4j/web/utils/FileUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand All @@ -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) {
Expand All @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand Down