Merge pull request #31 from Verdoso/Improve_Javadoc

Improved javadocs
Verdoso · Oct 4, 2018 · 5f319f2 · 5f319f2
2 parents 2110fbe + f4e1a92
commit 5f319f2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/...org/greeneyed/summer/config/hazelcast/HazelcastConsulSessionReplicationConfiguration.java b/...org/greeneyed/summer/config/hazelcast/HazelcastConsulSessionReplicationConfiguration.java
@@ -101,7 +101,7 @@ public static enum HEALTHCHECKTYPE {HTTP,TCP};
     @Autowired
     private ApplicationContext applicationContext;
 
-    /**
+    /*
      * All {@link HazelcastConfigurer} Beans to further customize Hazelcast configuration. If
      * spring does not find any matching bean, then the List is {@code null}!.
      */

diff --git a/summer-core/src/main/java/org/greeneyed/summer/controller/LogbackController.java b/summer-core/src/main/java/org/greeneyed/summer/controller/LogbackController.java
@@ -119,8 +119,8 @@ public ResponseEntity<LogResponse> list() {
 
     /**
      * 
-     * @param name
-     * @param level
+     * @param name The name of the logger we want to manipulate the level of
+     * @param level The new log level
      * @return The list of log levels configured and their settings
      */
     @RequestMapping(value = "set/{name}/{level}", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET,
@@ -146,7 +146,7 @@ public ResponseEntity<LogResponse> set(@PathVariable("name")
 
     /**
      * 
-     * @param name
+     * @param name The name of the logger we want to unset
      * @return The list of log levels configured and their settings
      */
     @RequestMapping(value = "unset/{name}/", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET,
@@ -206,9 +206,9 @@ private LogResponse listLoggers(final LoggerContext ctx) {
      * Captures the given logger at the given level so it can be displayed directly
      * by this controller.
      * 
-     * @param name
-     * @param level
-     * @param append
+     * @param name The name of the logger we want to capture
+     * @param level The level of logging we want to capture
+     * @param append Where we want to also send the logs to the regular pipes (true) or just capture it (false, default)
      * @return The list of log levels configured and their settings
      */
     @RequestMapping(value = "capture/{name}/{level}", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET,
@@ -235,7 +235,7 @@ public ResponseEntity<LogResponse> capture(@PathVariable("name")
      * Frees the given logger from the appender used to be displayed directly by
      * this controller.
      *
-     * @param name
+     * @param name The name of the logger we want to free from being captured
      * @return The list of log levels configured and their settings
      */
     @RequestMapping(value = "free/{name}/", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.GET,