Fix HTML Tags

Ensure that the HTML tags included are correctly used
pull/1/head
Hammy 3 years ago
parent 85e2158242
commit 02d2dcfda3

@ -14,11 +14,8 @@ import java.util.concurrent.Executor;
/**
* A MyWaifuClient
*
* <p> Main entry point for retrieving information from MyWaifuList. </p>
* <p> Main entry point for retrieving information from MyWaifuList.</p>
* <p> {@link MyWaifuWrapper} is utilised to make the API requests </p>
* <p> Examples of such methods include:
* <li>{@link }</li>
* </p>
*/
public class MyWaifuClient {
private final MyWaifuWrapper myWaifuWrapper;

@ -12,10 +12,14 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
* {@link PaginationData}
* <p>Contains standard Pagination data from the API</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link Integer currentPage}</li>
* <li>{@link Integer lastPage}</li>
* <li>{@link Integer perPage}</li>
* <li>{@link Integer total}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -14,9 +14,12 @@ import java.util.Objects;
* <p> Contains information on a given animation or game development studio </p>
*
* <p>Fields included are:</p>
* <ul>
* <li>{@link Integer id}</li>
* <li>{@link String name}</li>
* <li>{@link String originalName}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -15,6 +15,7 @@ import java.util.Objects;
* <p> Contains basic series information for most endpoints </p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link String name}</li>
* <li>{@link String originalName}</li>
* <li>{@link String romajiName}</li>
@ -22,6 +23,8 @@ import java.util.Objects;
* <li>{@link String description}</li>
* <li>{@link String url}</li>
* <li>{@link Integer id}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -16,6 +16,7 @@ import java.util.Objects;
* <p>Represents a grouping of various {@link Waifu}'s. This can be an anime, mobile game, video game, manga, or LN</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link String name}</li>
* <li>{@link String originalName}</li>
* <li>{@link String romajiName}</li>
@ -28,6 +29,8 @@ import java.util.Objects;
* <li>{@link String url}</li>
* <li>{@link Studio}</li>
* <li>{@link Integer id}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -14,9 +14,13 @@ import java.util.Objects;
* {@link TrueLove}
* <p>Represents a {@link User}'s True Love</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link String name}</li>
* <li>{@link String slug}</li>
* <li>{@link String series}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -16,6 +16,7 @@ import java.util.Objects;
* <p>Standard user information and counts of waifus created, liked, trashed. Also contains true love</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link Integer id}</li>
* <li>{@link String name}</li>
* <li>{@link String twitter}</li>
@ -24,6 +25,8 @@ import java.util.Objects;
* <li>{@link Integer waifusLiked}</li>
* <li>{@link Integer waifusTrashed}</li>
* <li>{@link TrueLove trueLove}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -14,10 +14,14 @@ import org.goudham.me.api.entity.waifu.Waifu;
* {@link UserList}
* <p>Get an array of all user lists on their profile</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link Integer id}</li>
* <li>{@link String name}</li>
* <li>{@link String order}</li>
* <li>{@link List< Waifu > waifus}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -13,6 +13,7 @@ import javax.annotation.processing.Generated;
* <p>Contains basic series information for most endpoints</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link String name}</li>
* <li>{@link String originalName}</li>
* <li>{@link String romajiName}</li>
@ -20,6 +21,8 @@ import javax.annotation.processing.Generated;
* <li>{@link String description}</li>
* <li>{@link String url}</li>
* <li>{@link Integer id}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -15,6 +15,7 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
* <p>Contains Waifu data structure for endpoints other than the primary endpoint (/waifu/{slug})</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link String slug}</li>
* <li>{@link String name}</li>
* <li>{@link String originalName}</li>
@ -26,6 +27,8 @@ import com.fasterxml.jackson.annotation.JsonPropertyOrder;
* <li>{@link String url}</li>
* <li>{@link List<Appearance> appearances}</li>
* <li>{@link Double id}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -20,6 +20,7 @@ import org.goudham.me.api.entity.series.Series;
* <p>Contains most common attributes for {@link Waifu}'s based on various source material</p>
*
* <p> Fields included are: </p>
* <ul>
* <li>{@link Integer id}</li>
* <li>{@link String slug}</li>
* <li>{@link Integer creatorId}</li>
@ -48,6 +49,8 @@ import org.goudham.me.api.entity.series.Series;
* <li>{@link Integer trashRank}</li>
* <li>{@link List<Appearance> appearances}</li>
* <li>{@link Series series}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

@ -10,12 +10,15 @@ import java.util.Objects;
/**
* {@link WaifuImage}
* <p>Contains a thumbnail & full res image link for an image in a given Waifus gallery</p>
* <p>Contains a thumbnail and full res image link for an image in a given Waifus gallery</p>
*
* <p>Fields included are:</p>
* <ul>
* <li>{@link Integer id}</li>
* <li>{@link String thumbnail}</li>
* <li>{@link String path}</li>
* </ul>
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({

Loading…
Cancel
Save