Improve javadoc

Author: LucaScorpion

src/main/java/com/scorpiac/javarant/User.java

@@ -81,6 +81,12 @@ public static User byUsername(String username) {
         return byId(json.get("user_id").getAsInt());
     }
 
+    /**
+     * Create a user from a JSON object.
+     *
+     * @param json The JSON object to create the user from.
+     * @return The created user.
+     */
     static User fromJson(JsonObject json) {
         return new User(
                 json.get("user_id").getAsInt(),
@@ -155,10 +161,16 @@ public boolean isFetched() {
         return fetched;
     }
 
+    /**
+     * Get the link to the user.
+     */
     public String userLink() {
         return DevRant.link(DevRant.USER_URL + "/" + username);
     }
 
+    /**
+     * Get the link to the user's avatar.
+     */
     public String avatarLink() {
         fetchData();
         return DevRant.AVATARS_URL + "/" + avatar;
@@ -185,61 +197,97 @@ public int getScore() {
         return score;
     }
 
+    /**
+     * Get information about the user.
+     */
     public String getAbout() {
         fetchData();
         return about;
     }
 
+    /**
+     * Get the user's location.
+     */
     public String getLocation() {
         fetchData();
         return location;
     }
 
+    /**
+     * Get the user's skills.
+     */
     public String getSkills() {
         fetchData();
         return skills;
     }
 
+    /**
+     * Get the user's GitHub username.
+     */
     public String getGithub() {
         fetchData();
         return github;
     }
 
+    /**
+     * Get the rants that this user posted.
+     */
     public Rant[] getRants() {
         fetchData();
         return rants;
     }
 
+    /**
+     * Get the rants that this user upvoted.
+     */
     public Rant[] getUpvoted() {
         fetchData();
         return upvoted;
     }
 
+    /**
+     * Get this user's comments.
+     */
     public Comment[] getComments() {
         fetchData();
         return comments;
     }
 
+    /**
+     * Get this user's favorites.
+     */
     public Rant[] getFavorites() {
         fetchData();
         return favorites;
     }
 
+    /**
+     * Get the amount of rants that this user has posted.
+     */
     public int getRantsCount() {
         fetchData();
         return rantsCount;
     }
 
+    /**
+     * Get the amount of rants that this user has upvoted.
+     */
     public int getUpvotedCount() {
         fetchData();
         return upvotedCount;
     }
 
+    /**
+     * Get the amount of comments that this user has posted.
+     */
     public int getCommentsCount() {
         fetchData();
         return commentsCount;
     }
 
+    /**
+     * Get the amount of rants that this user has favorited.
+     */
     public int getFavoritesCount() {
         fetchData();
         return favoritesCount;

src/main/java/com/scorpiac/javarant/Util.java

@@ -12,6 +12,14 @@ class Util {
     private Util() {
     }
 
+    /**
+     * Create a list from a JSON array.
+     *
+     * @param json      The JSON array to convert to a list.
+     * @param converter The converter for converting individual JSON elements.
+     * @param <T>       The type to convert the elements to.
+     * @return A list of elements converted from the JSON.
+     */
     static <T> List<T> jsonToList(JsonArray json, Function<JsonElement, T> converter) {
         List<T> result = new ArrayList<>(json.size());
         json.forEach(j -> result.add(converter.apply(j)));