Change javadocs to use consistent convention and add some missing documentation

Author: rabelenda-abstracta

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/BaseTestElement.java

@@ -5,7 +5,7 @@
 import org.apache.jorphan.collections.HashTree;
 
 /**
- * This class provides the basic logic for all {@link DslTestElement}.
+ * Provides the basic logic for all {@link DslTestElement}.
  *
  * In particular it currently allows to set the name of the TestElement and abstracts building of
  * the tree only requiring, from sub classes, to implement the logic to build the JMeter

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/DslSampler.java

@@ -6,9 +6,9 @@
 import us.abstracta.jmeter.javadsl.http.DslHttpSampler;
 
 /**
- * This abstract class hosts the logic common to all samplers.
+ * Hosts common logic to all samplers.
  *
- * In particular this class specifies that samplers are {@link ThreadGroupChild} and {@link
+ * In particular it specifies that samplers are {@link ThreadGroupChild} and {@link
  * TestElementContainer} containing {@link SamplerChild}.
  *
  * For an example of an implementation of a sampler check {@link DslHttpSampler}.

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/DslTestElement.java

@@ -3,7 +3,7 @@
 import org.apache.jorphan.collections.HashTree;
 
 /**
- * This is the interface to implement by all elements composing a JMeter test plan.
+ * Interface to be implemented by all elements composing a JMeter test plan.
  */
 public interface DslTestElement {
 

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/DslThreadGroup.java

@@ -9,7 +9,7 @@
 import us.abstracta.jmeter.javadsl.core.DslThreadGroup.ThreadGroupChild;
 
 /**
- * This class represents the standard thread group test element included by JMeter.
+ * Represents the standard thread group test element included by JMeter.
  *
  * Additional methods should be added in the future to support setting rump-up, start and end
  * scheduling.
@@ -38,8 +38,8 @@ public TestElement buildTestElement() {
   }
 
   /**
-   * Test elements that can be added as direct children of a thread group in jmeter, should
-   * implement this interface.
+   * Test elements that can be added as direct children of a thread group in jmeter should implement
+   * this interface.
    */
   public interface ThreadGroupChild extends DslTestElement {
 

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/JtlWriter.java

@@ -8,8 +8,8 @@
 import us.abstracta.jmeter.javadsl.core.DslThreadGroup.ThreadGroupChild;
 
 /**
- * This class allows to generate a result log file (JTL) with data for each sample for a test plan,
- * thread group or sampler, depending at what level of test plan is added.
+ * Allows to generate a result log file (JTL) with data for each sample for a test plan, thread
+ * group or sampler, depending at what level of test plan is added.
  *
  * If jtlWriter is added at testPlan level it will log information about all samples in the test
  * plan, if added at thread group level it will only log samples for samplers contained within it,

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/core/TestElementContainer.java

@@ -6,9 +6,9 @@
 import org.apache.jorphan.collections.HashTree;
 
 /**
- * This class abstracts logic for {@link DslTestElement} that can nest other test elements.
+ * Abstracts logic for {@link DslTestElement} that can nest other test elements.
  *
- * @param <T> The type of test elements that can be nested by this class.
+ * @param <T> is type of test elements that can be nested by this class.
  *
  * Check {@link DslTestPlan} for an example.
  */

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/http/DslHttpSampler.java

@@ -11,7 +11,7 @@
 import us.abstracta.jmeter.javadsl.core.DslSampler;
 
 /**
- * This allow to configure a JMeter HTTP sampler to make HTTP requests in a test plan.
+ * Allows to configure a JMeter HTTP sampler to make HTTP requests in a test plan.
  */
 public class DslHttpSampler extends DslSampler {
 
@@ -25,32 +25,74 @@ public DslHttpSampler(String name, String url) {
     this.url = url;
   }
 
+  /**
+   * Specifies that the sampler should send an HTTP POST to defined URL.
+   *
+   * @param body to include in HTTP POST request body.
+   * @param contentType to be sent as Content-Type header in HTTP POST request.
+   * @return the altered sampler to allow for fluent API usage.
+   */
   public DslHttpSampler post(String body, MimeTypes.Type contentType) {
     return method(HttpMethod.POST)
         .contentType(contentType)
         .body(body);
   }
 
+  /**
+   * Specifies the HTTP method to be used in the HTTP request generated by the sampler
+   *
+   * @param method is the HTTP method to be used by the sampler.
+   * @return the altered sampler to allow for fluent API usage.
+   */
   public DslHttpSampler method(HttpMethod method) {
     this.method = method;
     return this;
   }
 
+  /**
+   * Specifies an HTTP header to be sent by the sampler.
+   *
+   * To specify multiple headers just invoke this method several times with the different header
+   * names and values.
+   *
+   * @param name of the HTTP header.
+   * @param value of the HTTP header.
+   * @return the altered sampler to allow for fluent API usage.
+   */
   public DslHttpSampler header(String name, String value) {
     headers.header(name, value);
     return this;
   }
 
+  /**
+   * Allows to easily specify the Content-Type HTTP header to be used by the sampler.
+   *
+   * @param contentType value to send as Content-Type header.
+   * @return the altered sampler to allow for fluent API usage.
+   */
   public DslHttpSampler contentType(MimeTypes.Type contentType) {
     headers.contentType(contentType);
     return this;
   }
 
+  /**
+   * Specifies the body to be sent in the HTTP request generated by the sampler.
+   *
+   * @param body to be used as in the body of the HTTP request.
+   * @return the altered sampler to allow for fluent API usage.
+   */
   public DslHttpSampler body(String body) {
     this.body = body;
     return this;
   }
 
+  /**
+   * Allows specifying children test elements for the sampler, which allow for example extracting
+   * information from HTTP response, alter HTTP request, assert HTTP response contents, etc.
+   *
+   * @param children list of test elements to add as children of this sampler.
+   * @return the altered sampler to allow for fluent API usage.
+   */
   public DslHttpSampler children(SamplerChild... children) {
     setChildren(children);
     return this;

jmeter-java-dsl/src/main/java/us/abstracta/jmeter/javadsl/http/HttpHeaders.java

@@ -34,11 +34,27 @@ public HttpHeaders() {
     super("HTTP Header Manager", HeaderPanel.class);
   }
 
+  /**
+   * Allows to set an HTTP header to be used by HTTP samplers.
+   *
+   * To specify multiple headers just invoke this method several times with the different header
+   * names and values.
+   *
+   * @param name of the HTTP header.
+   * @param value of the HTTP header.
+   * @return the altered HttpHeaders instant to allow for fluent API usage.
+   */
   public HttpHeaders header(String name, String value) {
     headers.put(name, value);
     return this;
   }
 
+  /**
+   * Allows to easily specify the Content-Type HTTP header.
+   *
+   * @param contentType value to use as Content-Type header.
+   * @return the altered HttpHeaders to allow for fluent API usage.
+   */
   public HttpHeaders contentType(MimeTypes.Type contentType) {
     headers.put(HttpHeader.CONTENT_TYPE.toString(), contentType.toString());
     return this;