improve documentation

Author: jochen-testingbot

src/main/java/com/testingbot/models/TestingbotJob.java

@@ -6,8 +6,10 @@
 import java.util.List;
 
 /**
- * Represents a job (e.g. a Codeless test run) on TestingBot.
+ * Status of a job (e.g. a Codeless test run) on TestingBot.
  * See <a href="https://testingbot.com/support/api">https://testingbot.com/support/api</a>.
+ *
+ * @since 1.1.0
  */
 public class TestingbotJob implements Serializable {
     private static final long serialVersionUID = 1L;

src/main/java/com/testingbot/models/TestingbotLabAlert.java

@@ -2,6 +2,11 @@
 
 import java.io.Serializable;
 
+/**
+ * Alert configuration for a Codeless test ({@code kind}, {@code level}, destination).
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabAlert implements Serializable {
     private static final long serialVersionUID = 1L;
     private String type;

src/main/java/com/testingbot/models/TestingbotLabCreateAck.java

@@ -4,6 +4,11 @@
 
 import java.io.Serializable;
 
+/**
+ * Response from creating a Codeless test — carries the new {@code lab_test_id}.
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabCreateAck implements Serializable {
     private static final long serialVersionUID = 1L;
     private boolean success;

src/main/java/com/testingbot/models/TestingbotLabRunAck.java

@@ -4,6 +4,11 @@
 
 import java.io.Serializable;
 
+/**
+ * Response from triggering a Codeless test or suite — carries the {@code job_id}.
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabRunAck implements Serializable {
     private static final long serialVersionUID = 1L;
     private boolean success;

src/main/java/com/testingbot/models/TestingbotLabSuite.java

@@ -5,6 +5,11 @@
 import java.io.Serializable;
 import java.util.List;
 
+/**
+ * A Codeless test suite (a group of Codeless tests run together).
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabSuite implements Serializable {
     private static final long serialVersionUID = 1L;
     private int id;

src/main/java/com/testingbot/models/TestingbotLabSuiteCollection.java

@@ -4,6 +4,11 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 
+/**
+ * Paginated list of Codeless test suites ({@code data} + {@code meta}).
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabSuiteCollection implements Serializable {
     private static final long serialVersionUID = 1L;
     private ArrayList<TestingbotLabSuite> data = new ArrayList<>();

src/main/java/com/testingbot/models/TestingbotLabSuiteCreateAck.java

@@ -4,6 +4,11 @@
 
 import java.io.Serializable;
 
+/**
+ * Response from creating a Codeless test suite — carries the new {@code suite_id}.
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabSuiteCreateAck implements Serializable {
     private static final long serialVersionUID = 1L;
     private boolean success;

src/main/java/com/testingbot/models/TestingbotLabTest.java

@@ -5,6 +5,11 @@
 import java.io.Serializable;
 import java.util.List;
 
+/**
+ * A Codeless test definition (target URL, schedule, alerts, browsers).
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabTest implements Serializable {
     private static final long serialVersionUID = 1L;
     private int id;

src/main/java/com/testingbot/models/TestingbotLabTestCollection.java

@@ -4,6 +4,11 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 
+/**
+ * Paginated list of Codeless tests ({@code data} + {@code meta}).
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabTestCollection implements Serializable {
     private static final long serialVersionUID = 1L;
     private ArrayList<TestingbotLabTest> data = new ArrayList<>();

src/main/java/com/testingbot/models/TestingbotLabTestStep.java

@@ -4,6 +4,11 @@
 
 import java.io.Serializable;
 
+/**
+ * A single step within a Codeless test (command + locator + value).
+ *
+ * @since 1.1.0
+ */
 public class TestingbotLabTestStep implements Serializable {
     private static final long serialVersionUID = 1L;
     @SerializedName("test_order") private int testOrder;