From 430f49aae6300137d30a48848b0648785bf35ec3 Mon Sep 17 00:00:00 2001 From: wing328 Date: Tue, 5 Jul 2016 20:38:04 +0800 Subject: [PATCH] fix javadoc error --- .../Java/libraries/retrofit2/api.mustache | 4 +-- .../java/io/swagger/client/api/FakeApi.java | 8 ++--- .../java/io/swagger/client/api/PetApi.java | 32 +++++++++---------- .../java/io/swagger/client/api/StoreApi.java | 16 +++++----- .../java/io/swagger/client/api/UserApi.java | 32 +++++++++---------- 5 files changed, 46 insertions(+), 46 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/api.mustache b/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/api.mustache index 398cbe6a1327..7fa42fe732c8 100644 --- a/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/api.mustache +++ b/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/api.mustache @@ -25,12 +25,12 @@ public interface {{classname}} { * {{summary}} * {{notes}} {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} -{{/allParams}} * @return Call[{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}] +{{/allParams}} * @return Call<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}> */ {{#formParams}}{{#-first}} {{#isMultipart}}@Multipart{{/isMultipart}}{{^isMultipart}}@FormUrlEncoded{{/isMultipart}}{{/-first}}{{/formParams}} @{{httpMethod}}("{{path}}") - {{#useRxJava}}Observable{{/useRxJava}}{{^useRxJava}}Call{{/useRxJava}}[{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}] {{operationId}}({{^allParams}});{{/allParams}} + {{#useRxJava}}Observable{{/useRxJava}}{{^useRxJava}}Call{{/useRxJava}}<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{^allParams}});{{/allParams}} {{#allParams}}{{>libraries/retrofit2/queryParams}}{{>libraries/retrofit2/pathParams}}{{>libraries/retrofit2/headerParams}}{{>libraries/retrofit2/bodyParams}}{{>libraries/retrofit2/formParams}}{{#hasMore}}, {{/hasMore}}{{^hasMore}} );{{/hasMore}}{{/allParams}} diff --git a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/FakeApi.java b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/FakeApi.java index 4b2149758a78..042a6ba37e57 100644 --- a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/FakeApi.java +++ b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/FakeApi.java @@ -33,12 +33,12 @@ public interface FakeApi { * @param date None (optional) * @param dateTime None (optional) * @param password None (optional) - * @return Call[Void] + * @return Call<Void> */ @FormUrlEncoded @POST("fake") - Call[Void] testEndpointParameters( + Call testEndpointParameters( @Field("number") BigDecimal number, @Field("double") Double _double, @Field("string") String string, @Field("byte") byte[] _byte, @Field("integer") Integer integer, @Field("int32") Integer int32, @Field("int64") Long int64, @Field("float") Float _float, @Field("binary") byte[] binary, @Field("date") LocalDate date, @Field("dateTime") DateTime dateTime, @Field("password") String password ); @@ -48,12 +48,12 @@ public interface FakeApi { * @param enumQueryString Query parameter enum test (string) (optional, default to -efg) * @param enumQueryInteger Query parameter enum test (double) (optional) * @param enumQueryDouble Query parameter enum test (double) (optional) - * @return Call[Void] + * @return Call<Void> */ @FormUrlEncoded @GET("fake") - Call[Void] testEnumQueryParameters( + Call testEnumQueryParameters( @Field("enum_query_string") String enumQueryString, @Query("enum_query_integer") BigDecimal enumQueryInteger, @Field("enum_query_double") Double enumQueryDouble ); diff --git a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/PetApi.java b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/PetApi.java index 23e97996c663..a55cb2ee17f1 100644 --- a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/PetApi.java +++ b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/PetApi.java @@ -22,11 +22,11 @@ public interface PetApi { * Add a new pet to the store * * @param body Pet object that needs to be added to the store (required) - * @return Call[Void] + * @return Call<Void> */ @POST("pet") - Call[Void] addPet( + Call addPet( @Body Pet body ); @@ -35,11 +35,11 @@ public interface PetApi { * * @param petId Pet id to delete (required) * @param apiKey (optional) - * @return Call[Void] + * @return Call<Void> */ @DELETE("pet/{petId}") - Call[Void] deletePet( + Call deletePet( @Path("petId") Long petId, @Header("api_key") String apiKey ); @@ -47,11 +47,11 @@ public interface PetApi { * Finds Pets by status * Multiple status values can be provided with comma separated strings * @param status Status values that need to be considered for filter (required) - * @return Call[List] + * @return Call<List> */ @GET("pet/findByStatus") - Call[List] findPetsByStatus( + Call> findPetsByStatus( @Query("status") CSVParams status ); @@ -59,11 +59,11 @@ public interface PetApi { * Finds Pets by tags * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. * @param tags Tags to filter by (required) - * @return Call[List] + * @return Call<List> */ @GET("pet/findByTags") - Call[List] findPetsByTags( + Call> findPetsByTags( @Query("tags") CSVParams tags ); @@ -71,11 +71,11 @@ public interface PetApi { * Find pet by ID * Returns a single pet * @param petId ID of pet to return (required) - * @return Call[Pet] + * @return Call<Pet> */ @GET("pet/{petId}") - Call[Pet] getPetById( + Call getPetById( @Path("petId") Long petId ); @@ -83,11 +83,11 @@ public interface PetApi { * Update an existing pet * * @param body Pet object that needs to be added to the store (required) - * @return Call[Void] + * @return Call<Void> */ @PUT("pet") - Call[Void] updatePet( + Call updatePet( @Body Pet body ); @@ -97,12 +97,12 @@ public interface PetApi { * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) * @param status Updated status of the pet (optional) - * @return Call[Void] + * @return Call<Void> */ @FormUrlEncoded @POST("pet/{petId}") - Call[Void] updatePetWithForm( + Call updatePetWithForm( @Path("petId") Long petId, @Field("name") String name, @Field("status") String status ); @@ -112,12 +112,12 @@ public interface PetApi { * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) * @param file file to upload (optional) - * @return Call[ModelApiResponse] + * @return Call<ModelApiResponse> */ @Multipart @POST("pet/{petId}/uploadImage") - Call[ModelApiResponse] uploadFile( + Call uploadFile( @Path("petId") Long petId, @Part("additionalMetadata") String additionalMetadata, @Part("file\"; filename=\"file\"") RequestBody file ); diff --git a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/StoreApi.java b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/StoreApi.java index 97c331e1a583..3e19600bedb9 100644 --- a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/StoreApi.java +++ b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/StoreApi.java @@ -20,33 +20,33 @@ public interface StoreApi { * Delete purchase order by ID * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors * @param orderId ID of the order that needs to be deleted (required) - * @return Call[Void] + * @return Call<Void> */ @DELETE("store/order/{orderId}") - Call[Void] deleteOrder( + Call deleteOrder( @Path("orderId") String orderId ); /** * Returns pet inventories by status * Returns a map of status codes to quantities - * @return Call[Map] + * @return Call<Map> */ @GET("store/inventory") - Call[Map] getInventory(); + Call> getInventory(); /** * Find purchase order by ID * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions * @param orderId ID of pet that needs to be fetched (required) - * @return Call[Order] + * @return Call<Order> */ @GET("store/order/{orderId}") - Call[Order] getOrderById( + Call getOrderById( @Path("orderId") Long orderId ); @@ -54,11 +54,11 @@ public interface StoreApi { * Place an order for a pet * * @param body order placed for purchasing the pet (required) - * @return Call[Order] + * @return Call<Order> */ @POST("store/order") - Call[Order] placeOrder( + Call placeOrder( @Body Order body ); diff --git a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/UserApi.java b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/UserApi.java index 0b4a60bb79e4..3fc76b6a1b21 100644 --- a/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/UserApi.java +++ b/samples/client/petstore/java/retrofit2/src/main/java/io/swagger/client/api/UserApi.java @@ -20,11 +20,11 @@ public interface UserApi { * Create user * This can only be done by the logged in user. * @param body Created user object (required) - * @return Call[Void] + * @return Call<Void> */ @POST("user") - Call[Void] createUser( + Call createUser( @Body User body ); @@ -32,11 +32,11 @@ public interface UserApi { * Creates list of users with given input array * * @param body List of user object (required) - * @return Call[Void] + * @return Call<Void> */ @POST("user/createWithArray") - Call[Void] createUsersWithArrayInput( + Call createUsersWithArrayInput( @Body List body ); @@ -44,11 +44,11 @@ public interface UserApi { * Creates list of users with given input array * * @param body List of user object (required) - * @return Call[Void] + * @return Call<Void> */ @POST("user/createWithList") - Call[Void] createUsersWithListInput( + Call createUsersWithListInput( @Body List body ); @@ -56,11 +56,11 @@ public interface UserApi { * Delete user * This can only be done by the logged in user. * @param username The name that needs to be deleted (required) - * @return Call[Void] + * @return Call<Void> */ @DELETE("user/{username}") - Call[Void] deleteUser( + Call deleteUser( @Path("username") String username ); @@ -68,11 +68,11 @@ public interface UserApi { * Get user by user name * * @param username The name that needs to be fetched. Use user1 for testing. (required) - * @return Call[User] + * @return Call<User> */ @GET("user/{username}") - Call[User] getUserByName( + Call getUserByName( @Path("username") String username ); @@ -81,22 +81,22 @@ public interface UserApi { * * @param username The user name for login (required) * @param password The password for login in clear text (required) - * @return Call[String] + * @return Call<String> */ @GET("user/login") - Call[String] loginUser( + Call loginUser( @Query("username") String username, @Query("password") String password ); /** * Logs out current logged in user session * - * @return Call[Void] + * @return Call<Void> */ @GET("user/logout") - Call[Void] logoutUser(); + Call logoutUser(); /** @@ -104,11 +104,11 @@ public interface UserApi { * This can only be done by the logged in user. * @param username name that need to be deleted (required) * @param body Updated user object (required) - * @return Call[Void] + * @return Call<Void> */ @PUT("user/{username}") - Call[Void] updateUser( + Call updateUser( @Path("username") String username, @Body User body );