javadoc comments added.

Author: syslogic

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

@@ -239,12 +239,12 @@ public class GithubClient {
         return getService().getWorkflowJobs("token " + token, owner, repo, runId);
     }
 
-    /** It logs the URL of the call. */
-    public static void logUrl(@NonNull String tag, @NonNull Call<?> api) {
-        if (BuildConfig.DEBUG) {Log.w(tag, api.request().url() + "");}
-    }
-
-    /** Note: "bad credentials" means that the provided access-token is invalid. */
+    /**
+     * Utility: It parses the error-body of the call.
+     * Note: "bad credentials" means that the provided access-token is invalid.
+     * @param tag The desired log-tag.
+     * @param response Retrofit2 API response.
+     */
     public static void logError(@NonNull String tag, @NonNull Response<?> response) {
         if (BuildConfig.DEBUG && response.errorBody() != null) {
             try {
@@ -257,4 +257,13 @@ public static void logError(@NonNull String tag, @NonNull Response<?> response)
             }
         }
     }
+
+    /**
+     * Utility: It logs the URL of the call.
+     * @param tag The desired log-tag.
+     * @param api Retrofit2 API request.
+     */
+    public static void logUrl(@NonNull String tag, @NonNull Call<?> api) {
+        if (BuildConfig.DEBUG) {Log.w(tag, api.request().url() + "");}
+    }
 }

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

@@ -252,6 +252,14 @@ Call<WorkflowRunsResponse> getWorkflowRuns(
             @NonNull @Path(value = "repo") String repo
     );
 
+    /**
+     * GitHub Actions: Workflow Run.
+     * @param token the personal access token.
+     * @param owner the owner of the repository.
+     * @param repo the name of the repository.
+     * @param runId the ID of the workflow run.
+     * @return Retrofit2 call.
+     */
     @NonNull
     @GET("/repos/{owner}/{repo}/actions/runs/{runId}")
     Call<WorkflowRun> getWorkflowRun(
@@ -261,6 +269,14 @@ Call<WorkflowRun> getWorkflowRun(
             @NonNull @Path(value = "runId") Long runId
     );
 
+    /**
+     * GitHub Actions: Workflow Run Jobs.
+     * @param token the personal access token.
+     * @param owner the owner of the repository.
+     * @param repo the name of the repository.
+     * @param runId the ID of the workflow run.
+     * @return Retrofit2 call.
+     */
     @NonNull
     @GET("/repos/{owner}/{repo}/actions/runs/{runId}/jobs")
     Call<WorkflowJobsResponse> getWorkflowJobs(

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

@@ -17,23 +17,35 @@ public class Branch {
     @SerializedName("commit")
     private Commit commit;
 
-    /** Setter for name. */
+    /**
+     * Setter for name.
+     * @param value the name of the branch.
+     */
     public void setName(@NonNull String value) {
         this.name = value;
     }
 
-    /** Setter for commit. */
+    /**
+     * Setter for commit.
+     * @param item the commit to set.
+     */
     public void setCommit(@NonNull Commit item) {
         this.commit = item;
     }
 
-    /** Getter for commit. */
+    /**
+     * Getter for commit.
+     * @return instance of {@link Commit}.
+     */
     @NonNull
     public Commit getCommit() {
         return this.commit;
     }
 
-    /** Getter for name. */
+    /**
+     * Getter for name.
+     * @return the name of the branch.
+     */
     @NonNull
     public String getName() {
         return this.name;

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

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

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

@@ -36,56 +36,104 @@ public class License {
     @SerializedName("url")
     private String url;
 
+    /**
+     * Getter for id.
+     * @return the id of the license.
+     */
     @NonNull
     public Long getId() {
         return this.id;
     }
 
+    /**
+     * Getter for nodeId.
+     * @return the nodeId of the license.
+     */
     @NonNull
     public String getNodeId() {
         return this.nodeId;
     }
 
+    /**
+     * Getter for key.
+     * @return the key of the license.
+     */
     @NonNull
     public String getKey() {
         return this.key;
     }
 
+    /**
+     * Getter for spdxId.
+     * @return the spdxId of the license.
+     */
     @NonNull
     public String getSpdxId() {
         return this.spdxId;
     }
 
+    /**
+     * Getter for title.
+     * @return the title of the license.
+     */
     @NonNull
     public String getTitle() {
         return this.title;
     }
 
+    /**
+     * Getter for url.
+     * @return the url of the license.
+     */
     @NonNull
     public String getUrl() {
         return this.url;
     }
 
+    /**
+     * Setter for id.
+     * @param value the id of the license.
+     */
     public void setId(@NonNull Long value) {
         this.id = value;
     }
 
+    /**
+     * Setter for nodeId.
+     * @param value the nodeId of the license.
+     */
     public void setNodeId(@NonNull String value) {
         this.nodeId = value;
     }
 
+    /**
+     * Setter for key.
+     * @param value the key of the license.
+     */
     public void setKey(@NonNull String value) {
         this.key = value;
     }
 
+    /**
+     * Setter for spdxId.
+     * @param value the spdxId of the license.
+     */
     public void setSpdxId(@NonNull String value) {
         this.spdxId = value;
     }
 
+    /**
+     * Setter for title.
+     * @param value the title of the license.
+     */
     public void setTitle(@NonNull String value) {
         this.title = value;
     }
 
+    /**
+     * Setter for url.
+     * @param value the url of the license.
+     */
     public void setUrl(@NonNull String value) {
         this.url = value;
     }