more javadoc comments.

Author: syslogic

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

@@ -211,7 +211,10 @@ public void setIsRaw(boolean value) {
     }
 
 
-    /** It generates a dated query-string. */
+    /**
+     * It generates a dated query-string.
+     * @return the generated query-string.
+     */
     @NonNull
     public String toQueryString() {
         Calendar calendar = Calendar.getInstance();
@@ -220,6 +223,10 @@ public String toQueryString() {
         return this.getSearch() + this.getDateFilter();
     }
 
+    /**
+     * It generates the date-filter string.
+     * @return the generated date-filter string.
+     */
     @NonNull
     public String getDateFilter() {
         if (this.getIsRaw() || this.getParameter() == 0) {return "";}

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

@@ -17,19 +17,35 @@ public class RateLimits {
     @SerializedName("rate")
     private RateLimit rates;
 
+    /**
+     * Setter for {@link Resources}.
+     * @param item the resources.
+     */
     public void setResources(@NonNull Resources item) {
         this.resources = item;
     }
 
+    /**
+     * Setter for {@link RateLimit}.
+     * @param item the rates.
+     */
     public void setRate(@NonNull RateLimit item) {
         this.rates = item;
     }
 
+    /**
+     * Getter for {@link Resources}.
+     * @return the resources.
+     */
     @NonNull
     public Resources getResources() {
         return this.resources;
     }
 
+    /**
+     * Getter for {@link RateLimit}.
+     * @return the rates.
+     */
     @NonNull
     public RateLimit getRate() {
         return this.rates;

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

@@ -20,26 +20,46 @@ public class Repositories extends BaseModel {
     @SerializedName("total_count")
     private Long totalCount;
 
+    /**
+     * Setter for repositories.
+     * @param items the repositories.
+     */
     public void setRepositories(@NonNull ArrayList<Repository> items) {
         this.mItems = items;
     }
 
+    /**
+     * Setter for totalCount.
+     * @param value the total count of repositories.
+     */
     @SuppressWarnings("unused")
     public void setTotalCount(@NonNull Long value) {
         this.totalCount = value;
     }
 
+    /**
+     * Getter for repositories.
+     * @return the repositories.
+     */
     @NonNull
     public ArrayList<Repository> getRepositories() {
         return this.mItems;
     }
 
+    /**
+     * Getter for totalCount.
+     * @return the total count of repositories.
+     */
     @NonNull
     @Bindable
     public Long getTotalCount() {
         return this.totalCount;
     }
 
+    /**
+     * Getter for pageCount.
+     * @return the expected page count.
+     */
     @NonNull
     @Bindable
     public Long getPageCount() {

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

@@ -101,7 +101,12 @@ public class Repository extends BaseModel implements IContentProvider {
     /** Constructor */
     public Repository() {}
 
-    /** Constructor */
+    /**
+     * Constructor
+     * @param id the id of the repository.
+     * @param name the title of the repository.
+     * @param url the URL of the repository.
+     */
     @Ignore
     public Repository(@NonNull Long id, @NonNull String name, @NonNull String url) {
         this.setId(id);

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

@@ -20,26 +20,46 @@ public class RepositorySearch extends BaseModel {
     @SerializedName("total_count")
     private Long totalCount;
 
+    /**
+     * Setter for repositories.
+     * @param items the repositories.
+     */
     public void setRepositories(@NonNull ArrayList<Repository> items) {
         this.mItems = items;
     }
 
+    /**
+     * Setter for totalCount.
+     * @param value the total count of repositories.
+     */
     @SuppressWarnings("unused")
     public void setTotalCount(@NonNull Long value) {
         this.totalCount = value;
     }
 
+    /**
+     * Getter for repositories.
+     * @return the results.
+     */
     @NonNull
     public ArrayList<Repository> getRepositories() {
         return this.mItems;
     }
 
+    /**
+     * Getter for totalCount.
+     * @return total count of results.
+     */
     @NonNull
     @Bindable
     public Long getTotalCount() {
         return this.totalCount;
     }
 
+    /**
+     * Getter for pageCount.
+     * @return the expected page count.
+     */
     @NonNull
     @Bindable
     public Long getPageCount() {

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

@@ -54,120 +54,222 @@ public class WorkflowJob {
     @SerializedName("steps")
     private ArrayList<WorkflowStep> steps;
 
-    /** Setters... */
+    /**
+     * Setter for id.
+     * @param value the ID of the job.
+     */
     public void setId(@NonNull Long value) {
         this.id = value;
     }
 
+    /**
+     * Setter for name.
+     * @param value the name of the job.
+     */
     public void setName(@NonNull String value) {
         this.name = value;
     }
 
+    /**
+     * Setter for status.
+     * @param value the status of the job.
+     */
     public void setStatus(@NonNull String value) {
         this.status = value;
     }
 
+    /**
+     * Setter for conclusion.
+     * @param value the conclusion of the job.
+     */
     public void setConclusion(@NonNull String value) {
         this.conclusion = value;
     }
 
+    /**
+     * Setter for runId.
+     * @param value the runId of the job.
+     */
     public void setRunId(@NonNull Long value) {
         this.runId = value;
     }
 
+    /**
+     * Setter for runUrl.
+     * @param value the runUrl of the job.
+     */
     public void setRunUrl(@NonNull String value) {
         this.runUrl = value;
     }
 
+    /**
+     * Setter for nodeId.
+     * @param value the nodeId of the job.
+     */
     public void setNodeId(@NonNull String value) {
         this.nodeId = value;
     }
 
+    /**
+     * Setter for headSha.
+     * @param value the headSha of the job.
+     */
     public void setHeadSha(@NonNull String value) {
         this.headSha = value;
     }
 
+    /**
+     * Setter for url.
+     * @param value the url of the job.
+     */
     public void setUrl(@NonNull String value) {
         this.url = value;
     }
 
+    /**
+     * Setter for htmlUrl.
+     * @param value the htmlUrl of the job.
+     */
     public void setHtmlUrl(@NonNull String value) {
         this.htmlUrl = value;
     }
 
+    /**
+     * Setter for startedAt.
+     * @param value the startedAt of the job.
+     */
     public void setStartedAt(@NonNull Date value) {
         this.startedAt = value;
     }
 
+    /**
+     * Setter for completedAt.
+     * @param value the completedAt of the job.
+     */
     public void setCompletedAt(@NonNull Date value) {
         this.completedAt = value;
     }
 
+    /**
+     * Setter for steps.
+     * @param value the steps of the job.
+     */
     public void setSteps(@NonNull ArrayList<WorkflowStep> value) {
         this.steps = value;
     }
 
-    /** Getters... */
+    /**
+     * Getter for id.
+     * @return the id of the job.
+     */
     @NonNull
     public Long getId() {
         return this.id;
     }
 
+    /**
+     * Getter for name.
+     * @return the name of the job.
+     */
     @NonNull
     public String getName() {
         return this.name;
     }
 
+    /**
+     * Getter for status.
+     * @return the status of the job.
+     */
     @NonNull
     public String getStatus() {
         return this.status;
     }
 
+    /**
+     * Getter for conclusion.
+     * @return the conclusion of the job.
+     */
     @NonNull
     public String getConclusion() {
         return this.conclusion;
     }
 
+    /**
+     * Getter for runId.
+     * @return the runId of the job.
+     */
     @NonNull
     public Long getRunId() {
         return this.runId;
     }
 
+    /**
+     * Getter for runUrl.
+     * @return the runUrl of the job.
+     */
     @NonNull
     public String getRunUrl() {
         return this.runUrl;
     }
 
+    /**
+     * Getter for nodeId.
+     * @return the nodeId of the job.
+     */
     @NonNull
     public String getNodeId() {
         return this.nodeId;
     }
 
+    /**
+     * Getter for headSha.
+     * @return the headSha of the job.
+     */
     @NonNull
     public String getHeadSha() {
         return this.headSha;
     }
 
+    /**
+     * Getter for url.
+     * @return the url of the job.
+     */
     @NonNull
     public String getUrl() {
         return this.url;
     }
 
+    /**
+     * Getter for htmlUrl.
+     * @return the htmlUrl of the job.
+     */
     @NonNull
     public String getHtmlUrl() {
         return this.htmlUrl;
     }
 
+    /**
+     * Getter for startedAt.
+     * @return the startedAt of the job.
+     */
     @NonNull
     public Date getStartedAt() {
         return this.startedAt;
     }
 
+    /**
+     * Getter for completedAt.
+     * @return the completedAt of the job.
+     */
     @NonNull
     public Date getCompletedAt() {
         return this.completedAt;
     }
 
+    /**
+     * Getter for steps.
+     * @return the steps of the job.
+     */
     @NonNull
     public ArrayList<WorkflowStep> getSteps() {
         return this.steps;