update interceptor documentation (#2172)

* edit docs

* fix default value

* rm

Author: russelmrcl

core/src/main/java/com/predic8/membrane/core/interceptor/balancer/LoadBalancingInterceptor.java

@@ -35,7 +35,7 @@
 
 /**
  * @description Performs load-balancing between several nodes. Nodes sharing session state may be bundled into a cluster.
- * @explanation May only be used as interceptor in a ServiceProxy.
+ * @explanation May only be used as interceptor in a serviceProxy or api.
  * @topic 2. Enterprise Integration Patterns
  */
 @MCElement(name = "balancer")
@@ -188,7 +188,7 @@ private Session getSession(String sessionId) {
      * This is *NOT* {@link #setDisplayName(String)}, but the balancer's name
      * set in the proxy configuration to identify this balancer.
      *
-     * @description Uniquely identifies this Load Balancer, if there is more than one. Used
+     * @description Uniquely identifies this load balancer, if there is more than one. Used
      * in the web administration interface and lbclient to manage nodes.
      * @example balancer1
      * @default Default

core/src/main/java/com/predic8/membrane/core/interceptor/flow/IfInterceptor.java

@@ -29,13 +29,12 @@
 
 /**
  * @description <p>
- * The "if" interceptor supports conditional execution of nested plugins.
+ * if allows conditional execution of nested interceptors.
  * </p>
- * See:
- * - com.predic8.membrane.core.interceptor.flow.IfInterceptorSpELTest
- * - com.predic8.membrane.core.interceptor.flow.IfInterceptorGroovyTest
- * - com.predic8.membrane.core.interceptor.flow.IfInterceptorJsonpathTest
- * - com.predic8.membrane.core.interceptor.flow.IfInterceptorXPathTest
+ * <pre><code><if test="method == 'POST'" language="SpEL">
+ *     ...
+ * </if>
+ * </code></pre>
  * @topic 1. Proxies and Flow
  */
 @MCElement(name = "if")
@@ -100,8 +99,8 @@ public Language getLanguage() {
     }
 
     /**
-     * @description the language of the 'test' condition
-     * @default groovy
+     * @description Language of the 'test' condition
+     * @default SpEL
      * @example SpEL, groovy, jsonpath, xpath
      */
     @MCAttribute
@@ -114,8 +113,8 @@ public String getTest() {
     }
 
     /**
-     * @description the condition to be tested
-     * @example exc.request.header.userAgentSupportsSNI
+     * @description Condition to be tested
+     * @example <ul><li>request.isJSON()</li><li>params['limit'] >= 0</li><li>statusCode matches '[45]\d\d'</li></ul>
      */
     @Required
     @MCAttribute

core/src/main/java/com/predic8/membrane/core/interceptor/flow/ReturnInterceptor.java

@@ -39,7 +39,7 @@
  * 2. If there is no response in the exchange, the body and contentType of the request is copied into a new response.
  * </p>
  * <p>
- * The options statusCode and contentType will overwrite the values from the messages.
+ * The options <i>statusCode</i> and <i>contentType</i> will overwrite the values from the messages.
  * </p>
  * <p>
  * This plugin is useful together with the template plugin. See examples/template.
@@ -121,7 +121,7 @@ public EnumSet<Flow> getFlow() {
     }
 
     /**
-     * @description The HTTP status code to be returned.
+     * @description HTTP status code to be returned.
      * @default 200
      * @example 400
      */
@@ -135,7 +135,7 @@ public int getStatusCode() {
     }
 
     /**
-     * @description The content type of the response. If not set, the content type of the request (if available) or no content type will be used.
+     * @description Content type of the response. If not set, the content type of the request (if available) or no content type will be used.
      * @default null
      * @example application/json; charset=utf-8
      */