This is an automated email from the ASF dual-hosted git repository. jamesbognar pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/juneau-petstore.git
commit f887f89990898a540f2f06f48d72d96ad56a2462 Author: JamesBognar <[email protected]> AuthorDate: Sun Sep 15 18:29:25 2019 -0400 Fix javadocs. --- .../src/main/java/org/apache/juneau/petstore/PetStore.java | 2 -- .../src/main/java/org/apache/juneau/petstore/dto/CreatePet.java | 1 - .../src/main/java/org/apache/juneau/petstore/dto/Species.java | 1 + .../src/main/java/org/apache/juneau/petstore/Main.java | 2 +- .../src/main/java/org/apache/juneau/petstore/App.java | 3 ++- .../src/main/java/org/apache/juneau/petstore/AppConfiguration.java | 1 + .../apache/juneau/petstore/service/AbstractPersistenceService.java | 4 +++- 7 files changed, 8 insertions(+), 6 deletions(-) diff --git a/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/PetStore.java b/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/PetStore.java index 8bdfd47..f7faf0f 100644 --- a/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/PetStore.java +++ b/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/PetStore.java @@ -377,8 +377,6 @@ public interface PetStore { * @param password The password for login in clear text. * @param rateLimit Calls per hour allowed by the user. * @param expiresAfter The <bc>Expires-After</bc> response header. - * @param req The servlet request. - * @param res The servlet response. * @return {@link Ok} if successful. * @throws InvalidLogin Login was unsuccessful. * @throws NotAcceptable Unsupported <c>Accept</c> header specified. diff --git a/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/CreatePet.java b/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/CreatePet.java index 2064cc2..a886616 100644 --- a/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/CreatePet.java +++ b/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/CreatePet.java @@ -44,7 +44,6 @@ public class CreatePet { * @param price The <bc>price</bc> property value. * @param species The <bc>species</bc> property value. * @param tags The <bc>tags</bc> property value. - * @param photo The <bc>photo</bc> property value. */ public CreatePet(String name, float price, Species species, String[] tags) { this.name = name; diff --git a/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/Species.java b/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/Species.java index 90a54e3..d8c3785 100644 --- a/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/Species.java +++ b/juneau-petstore-api/src/main/java/org/apache/juneau/petstore/dto/Species.java @@ -19,6 +19,7 @@ package org.apache.juneau.petstore.dto; * <li class='extlink'>{@source} * </ul> */ +@SuppressWarnings("javadoc") public enum Species { BIRD, CAT, DOG, FISH, MOUSE, RABBIT, SNAKE; } diff --git a/juneau-petstore-client/src/main/java/org/apache/juneau/petstore/Main.java b/juneau-petstore-client/src/main/java/org/apache/juneau/petstore/Main.java index d005383..882de17 100644 --- a/juneau-petstore-client/src/main/java/org/apache/juneau/petstore/Main.java +++ b/juneau-petstore-client/src/main/java/org/apache/juneau/petstore/Main.java @@ -29,6 +29,7 @@ import org.apache.juneau.rest.client.*; * <p> * The remote proxy allows you to make REST calls against our REST interface through Java interface method calls. */ +@SuppressWarnings("javadoc") public class Main { private static final JsonParser JSON_PARSER = JsonParser.create().ignoreUnknownBeanProperties().build(); @@ -59,7 +60,6 @@ public class Main { * Initialize the petstore database by using a remote resource interface against our REST. * * @param w Console output. - * @return This object (for method chaining). * @throws ParseException Malformed input encountered. * @throws IOException Thrown by client stream. */ diff --git a/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/App.java b/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/App.java index f04953b..e79b507 100644 --- a/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/App.java +++ b/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/App.java @@ -20,9 +20,10 @@ import org.springframework.boot.builder.SpringApplicationBuilder; * Entry point for PetStore application. */ @SpringBootApplication +@SuppressWarnings("javadoc") public class App { - public static void main(String[] args) { + public static void main(String[] args) { new App().start(args); } diff --git a/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/AppConfiguration.java b/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/AppConfiguration.java index d3d7370..fd1b5f8 100644 --- a/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/AppConfiguration.java +++ b/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/AppConfiguration.java @@ -19,6 +19,7 @@ import org.springframework.boot.web.servlet.*; import org.springframework.context.annotation.*; import org.springframework.web.filter.*; +@SuppressWarnings("javadoc") @Configuration public class AppConfiguration { diff --git a/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/service/AbstractPersistenceService.java b/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/service/AbstractPersistenceService.java index 4e2aedf..6bacab0 100644 --- a/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/service/AbstractPersistenceService.java +++ b/juneau-petstore-server/src/main/java/org/apache/juneau/petstore/service/AbstractPersistenceService.java @@ -170,6 +170,7 @@ public class AbstractPersistenceService { * @param query The JPA query. * @param t The bean type. * @param searchArgs Optional search arguments. + * @param pageArgs Optional paging arguments. * @return The results. */ protected <T> List<T> query(EntityManager em, String query, Class<T> t, SearchArgs searchArgs, PageArgs pageArgs) { @@ -182,12 +183,13 @@ public class AbstractPersistenceService { } /** - * Same as {@link #query(EntityManager,String,Class,SearchArgs)} but uses a new entity manager. + * Same as {@link #query(EntityManager,String,Class,SearchArgs,PageArgs)} but uses a new entity manager. * * @param <T> The bean type. * @param query The JPA query. * @param t The bean type. * @param searchArgs Optional search arguments. + * @param pageArgs Optional paging arguments. * @return The results. */ protected <T> List<T> query(String query, Class<T> t, SearchArgs searchArgs, PageArgs pageArgs) {
