javadoc fixes

testingbot · May 10, 2024 · bc62d07 · bc62d07
1 parent ab89375
commit bc62d07
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -13,7 +13,7 @@ jobs:
           distribution: 'adopt'
           java-version: '8'
       - name: Test
-        run: mvn install -Dmaven.javadoc.skip=true -Dgpg.skip=true -B -V
+        run: mvn install -Dgpg.skip=true -B -V
         env:
           TB_KEY: ${{ secrets.TB_KEY }}
           TB_SECRET: ${{ secrets.TB_SECRET }}
diff --git a/src/main/java/com/testingbot/models/TestingbotBrowser.java b/src/main/java/com/testingbot/models/TestingbotBrowser.java
@@ -4,6 +4,13 @@
 
 import java.io.Serializable;
 
+/**
+ * Holds information about the TestingbotBrowser items that TestingBot provides
+ * You can find the list of browsers on
+ * <a href="https://testingbot.com/support/getting-started/browsers.html">https://testingbot.com/support/getting-started/browsers.html</a>.
+ *
+ * @author TestingBot
+ */
 public class TestingbotBrowser implements Serializable {
     private static final long serialVersionUID = 1L;
     private String name;

diff --git a/src/main/java/com/testingbot/testingbotrest/TestingbotREST.java b/src/main/java/com/testingbot/testingbotrest/TestingbotREST.java
@@ -127,7 +127,7 @@ public boolean deleteTest(String sessionID) {
     /**
      * Gets list of available browsers from TestingBot
      *
-     * @return ArrayList<TestingbotBrowser>
+     * @return ArrayList containing TestingbotBrowser objects.
      */
     public ArrayList<TestingbotBrowser> getBrowsers() {
         return this.apiGet("https://api.testingbot.com/v1/browsers", TypeToken.getParameterized(ArrayList.class, TestingbotBrowser.class).getType());
@@ -405,7 +405,7 @@ public TestingBotStorageFileCollection getStorageFiles(int offset, int count) {
      *
      * @param offset where to begin
      * @param count number of devices
-     * @return List<TestingbotDevice> devices
+     * @return List containing TestingbotDevice objects.
      */
     public List<TestingbotDevice> getAvailableDevices(int offset, int count) {
         return this.apiGet("https://api.testingbot.com/v1/devices/available/?offset=" + offset + "&count=" + count, TypeToken.getParameterized(List.class, TestingbotDevice.class).getType());
@@ -417,7 +417,7 @@ public List<TestingbotDevice> getAvailableDevices(int offset, int count) {
      *
      * @param offset where to begin
      * @param count number of real devices
-     * @return List<TestingbotDevice> devices
+     * @return List containing TestingbotDevice objects.
      */
     public List<TestingbotDevice> getDevices(int offset, int count) {
         return this.apiGet("https://api.testingbot.com/v1/devices/?offset=" + offset + "&count=" + count, TypeToken.getParameterized(List.class, TestingbotDevice.class).getType());