javadoc comments added.

Author: syslogic

library/src/main/java/io/syslogic/github/api/Constants.java

@@ -8,14 +8,28 @@
  * @author Martin Zeitler
  */
 public final class Constants {
+
+    /** GitHub API Base URL */
     @NonNull public static final String GITHUB_API_BASE_URL = "https://api.github.com/";
-    @NonNull public static final String GITHUB_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
 
-    /** Table Names */
+    /** GitHub API date-format. */
+    @NonNull public static final String GITHUB_API_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
+
+    /** Table name for QueryString. */
     @NonNull public static final String TABLE_QUERY_STRINGS = "query_strings";
+
+    /** Table name for Repository. */
     @NonNull public static final String TABLE_REPOSITORIES  = "repositories";
+
+    /** Table name for Workflow. */
     @NonNull public static final String TABLE_WORKFLOWS     = "workflows";
+
+    /** Table name for WorkflowRun. */
     @NonNull public static final String TABLE_WORKFLOW_RUNS = "workflow_runs";
+
+    /** Table name for License. */
     @NonNull public static final String TABLE_LICENSES      = "licenses";
+
+    /** Table name for Owner. */
     @NonNull public static final String TABLE_OWNERS        = "owners";
 }

library/src/main/java/io/syslogic/github/api/GithubClient.java

@@ -46,7 +46,7 @@ public class GithubClient {
         if (retrofit == null) {
 
             Gson gson = new GsonBuilder()
-                .setDateFormat(Constants.GITHUB_DATE_FORMAT)
+                .setDateFormat(Constants.GITHUB_API_DATE_FORMAT)
                 .create();
 
             OkHttpClient ok = new OkHttpClient.Builder()

library/src/main/java/io/syslogic/github/api/model/Branch.java

@@ -17,19 +17,23 @@ public class Branch {
     @SerializedName("commit")
     private Commit commit;
 
+    /** Setter for name. */
     public void setName(@NonNull String value) {
         this.name = value;
     }
 
+    /** Setter for commit. */
     public void setCommit(@NonNull Commit item) {
         this.commit = item;
     }
 
+    /** Getter for commit. */
     @NonNull
     public Commit getCommit() {
         return this.commit;
     }
 
+    /** Getter for name. */
     @NonNull
     public String getName() {
         return this.name;

library/src/main/java/io/syslogic/github/api/model/Commit.java

@@ -17,19 +17,23 @@ public class Commit {
     @SerializedName("url")
     private String url;
 
+    /** Setter for sha. */
     public void setSha(@NonNull String value) {
         this.sha = value;
     }
 
+    /** Setter for url. */
     public void setUrl(@NonNull String value) {
         this.url = value;
     }
 
+    /** Getter for sha. */
     @NonNull
     public String getSha() {
         return this.sha;
     }
 
+    /** Getter for url. */
     @NonNull
     public String getUrl() {
         return this.url;

library/src/main/java/io/syslogic/github/api/utils/StringArrayConverter.java

@@ -12,12 +12,20 @@
  */
 public class StringArrayConverter {
 
+    /**
+     * @param value a JSON string.
+     * @return an instance of {@link String[]}.
+     */
     @NonNull
     @TypeConverter
     public String[] fromJson(@NonNull String value) {
         return new Gson().fromJson(value, String[].class);
     }
 
+    /**
+     * @param value a string-array.
+     * @return a JSON string.
+     */
     @NonNull
     @TypeConverter
     public String toJson(@NonNull String[] value) {