more javadoc comments.

Author: syslogic

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

@@ -25,25 +25,32 @@
 @Entity(tableName = Constants.TABLE_QUERY_STRINGS)
 public class QueryString extends BaseModel implements IContentProvider {
 
+    /** ID */
     @PrimaryKey(autoGenerate = true)
     @ColumnInfo(name = "id")
     private long id;
 
+    /** Title */
     @ColumnInfo(name = "title")
     private String title = null;
 
+    /** Search */
     @ColumnInfo(name = "search")
     private String search = null;
 
+    /** Condition */
     @ColumnInfo(name = "condition")
     private String condition = "pushed";
 
+    /** Operator */
     @ColumnInfo(name = "operator")
     private String operator = ">";
 
+    /** Parameter */
     @ColumnInfo(name = "parameter")
     private int parameter = 7;
 
+    /** Is raw? */
     @ColumnInfo(name = "is_raw")
     private boolean isRaw = false;
 

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

@@ -27,74 +27,91 @@
 @SuppressWarnings(RoomWarnings.PRIMARY_KEY_FROM_EMBEDDED_IS_DROPPED)
 public class Repository extends BaseModel implements IContentProvider {
 
+    /** ID */
     @PrimaryKey()
     @ColumnInfo(name = "id")
     @SerializedName("id")
     private Long id;
 
+    /** NodeId */
     @ColumnInfo(name = "node_id")
     @SerializedName("node_id")
     private String nodeId;
 
+    /** Name */
     @ColumnInfo(name = "name")
     @SerializedName("name")
     private String name;
 
+    /** Full Name */
     @ColumnInfo(name = "full_name")
     @SerializedName("full_name")
     private String fullName;
 
+    /** File-Name */
     @Ignore
     private String fileName;
 
+    /** Url */
     @ColumnInfo(name = "url")
     @SerializedName("url")
     private String url;
 
+    /** HtmlUrl */
     @ColumnInfo(name = "html_url")
     @SerializedName("html_url")
     private String htmlUrl;
 
+    /** Owner */
     @Ignore
     @SerializedName("owner")
     private Owner owner;
 
+    /** OwnerId */
     @ColumnInfo(name = "owner_id")
     private Long ownerId = 0L;
 
+    /** License */
     @Ignore
     @SerializedName("license")
     private License license;
 
+    /** LicenseId */
     @SerializedName("license_id")
     @ColumnInfo(name = "license_id")
     private Long licenseId = 0L;
 
+    /** Forks */
     @SerializedName("forks_count")
     @ColumnInfo(name = "forks")
     private Long forkCount = 0L;
 
+    /** Stargazers */
     @SerializedName("stargazers_count")
     @ColumnInfo(name = "stargazers")
     private Long stargazerCount = 0L;
 
+    /** Watchers */
     @SerializedName("watchers_count")
     @ColumnInfo(name = "watchers")
     private Long watcherCount = 0L;
 
+    /** Subscribers */
     @SerializedName("subscribers_count")
     @ColumnInfo(name = "subscribers")
     private Long subscriberCount = 0L;
 
+    /** Network */
     @SerializedName("network_count")
     @ColumnInfo(name = "network")
     private Long networkCount = 0L;
 
+    /** Topics */
     @SerializedName("topics")
     @TypeConverters(StringArrayConverter.class)
     private String[] topics;
 
-    /** Being populated asynchronously. */
+    /** Workflows are being populated asynchronously. */
     @Ignore
     private ArrayList<Workflow> workflows = new ArrayList<>();
 

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

@@ -20,28 +20,52 @@ public class Resources {
     @SerializedName("graphql")
     private RateLimit graphql;
 
-    public void setSearch(@NonNull RateLimit value) {
-        this.search = value;
-    }
-
+    /**
+     * Setter for core {@link RateLimit}.
+     * @param value the rate limit.
+     */
     public void setCore(@NonNull RateLimit value) {
         this.core = value;
     }
 
+    /**
+     * Setter for search {@link RateLimit}.
+     * @param value the rate limit.
+     */
+    public void setSearch(@NonNull RateLimit value) {
+        this.search = value;
+    }
+
+    /**
+     * Setter for graphql {@link RateLimit}.
+     * @param value the rate limit.
+     */
     public void setGraphql(@NonNull RateLimit value) {
         this.graphql = value;
     }
 
+    /**
+     * Getter for core {@link RateLimit}.
+     * @return the rate limit.
+     */
     @NonNull
     public RateLimit getCore() {
         return this.core;
     }
 
+    /**
+     * Getter for search {@link RateLimit}.
+     * @return the rate limit.
+     */
     @NonNull
     public RateLimit getSearch() {
         return this.search;
     }
 
+    /**
+     * Getter for graphql {@link RateLimit}.
+     * @return the rate limit.
+     */
     @NonNull
     public RateLimit getGraphql() {
         return this.graphql;

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

@@ -106,92 +106,178 @@ public class User {
     @SerializedName("updated_at")
     private Date updatedAt;
 
-    /* Getters */
+    /**
+     * Getter for login.
+     * @return the login of the user.
+     */
     @NonNull public String getLogin() {
         return this.login;
     }
 
+    /**
+     * Getter for id.
+     * @return the id of the user.
+     */
     @NonNull public Long getId() {
         return this.id;
     }
 
+    /**
+     * Getter for nodeId.
+     * @return the nodeId of the user.
+     */
     @NonNull public String getNodeId() {
         return this.nodeId;
     }
 
+    /**
+     * Getter for avatarUrl.
+     * @return the avatarUrl of the user.
+     */
     @NonNull public String getAvatarUrl() {
         return this.avatarUrl;
     }
 
+    /**
+     * Getter for gravatarId.
+     * @return the gravatarId of the user.
+     */
     @NonNull public String getGravatarId() {
         return this.gravatarId;
     }
 
+    /**
+     * Getter for url.
+     * @return the url of the user.
+     */
     @NonNull public String getUrl() {
         return this.url;
     }
 
+    /**
+     * Getter for htmlUrl.
+     * @return the htmlUrl of the user.
+     */
     @NonNull public String getHtmlUrl() {
         return this.htmlUrl;
     }
 
+    /**
+     * Getter for reposUrl.
+     * @return the reposUrl of the user.
+     */
     @NonNull public String getReposUrl() {
         return this.reposUrl;
     }
 
+    /**
+     * Getter for type.
+     * @return the type of the user.
+     */
     @NonNull public String getType() {
         return this.type;
     }
 
+    /**
+     * Getter for siteAdmin.
+     * @return is siteAdmin.
+     */
     @NonNull public Boolean getSiteAdmin() {
         return this.siteAdmin;
     }
 
+    /**
+     * Getter for name.
+     * @return the name of the user.
+     */
     @NonNull public String getName() {
         return this.name;
     }
 
-    /* Setters */
+    /**
+     * Setter for login.
+     * @param value the login of the user.
+     */
     public void setLogin(@NonNull String value) {
         this.login = value;
     }
 
+    /**
+     * Setter for id.
+     * @param value the id of the user.
+     */
     public void setId(@NonNull Long value) {
         this.id = value;
     }
 
+    /**
+     * Setter for nodeId.
+     * @param value the nodeId of the user.
+     */
     public void setNodeId(@NonNull String value) {
         this.nodeId = value;
     }
 
+    /**
+     * Setter for avatarUrl.
+     * @param value the avatarUrl of the user.
+     */
     public void setAvatarUrl(@NonNull String value) {
         this.avatarUrl = value;
     }
 
+    /**
+     * Setter for gravatarId.
+     * @param value the gravatarId of the user.
+     */
     public void setGravatarId(@NonNull String value) {
         this.gravatarId = value;
     }
 
+    /**
+     * Setter for url.
+     * @param value the url of the user.
+     */
     public void setUrl(@NonNull String value) {
         this.url = value;
     }
 
+    /**
+     * Setter for htmlUrl.
+     * @param value the htmlUrl of the user.
+     */
     public void setHtmlUrl(@NonNull String value) {
         this.htmlUrl = value;
     }
 
+    /**
+     * Setter for reposUrl.
+     * @param value the reposUrl of the user.
+     */
     public void setReposUrl(@NonNull String value) {
         this.reposUrl = value;
     }
 
+    /**
+     * Setter for type.
+     * @param value the type of the user.
+     */
     public void setType(@NonNull String value) {
         this.type = value;
     }
 
+    /**
+     * Setter for siteAdmin.
+     * @param value if the user is site-admin.
+     */
     public void setSiteAdmin(@NonNull Boolean value) {
         this.siteAdmin = value;
     }
 
+    /**
+     * Setter for name.
+     * @param value the name of the user.
+     */
     public void setName(@NonNull String value) {
         this.name = value;
     }