loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Merge pull request #2571 from wing328/objc-docstring

Browse Source 
[ObjC] update docstring in ObjC API header files
This commit is contained in:
wing328 2016-04-12 16:02:39 +08:00
commit cd91f457bf
5 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/swagger-codegen/src/main/resources/objc/api-header.mustache
View File

@ -27,7 +27,7 @@
/// {{{summary}}}
/// {{#notes}}{{{notes}}}{{/notes}}
///
/// {{#allParams}}@param {{paramName}} {{description}}
/// {{#allParams}}@param {{paramName}} {{description}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
/// {{/allParams}}
///
/// @return {{{returnType}}}

2
samples/client/petstore/objc/README.md
View File

@ -6,7 +6,7 @@ This ObjC package is automatically generated by the [Swagger Codegen](https://gi
- API version: 1.0.0
- Package version:
- Build date: 2016-04-10T18:34:45.604+08:00
- Build date: 2016-04-12T15:30:12.334+08:00
- Build package: class io.swagger.codegen.languages.ObjcClientCodegen
## Requirements

20
samples/client/petstore/objc/SwaggerClient/SWGPetApi.h
View File

@ -25,7 +25,7 @@
/// Add a new pet to the store
///
///
/// @param body Pet object that needs to be added to the store
/// @param body Pet object that needs to be added to the store (optional)
///
///
/// @return
@ -38,7 +38,7 @@
/// Fake endpoint to test byte array in body parameter for adding a new pet to the store
///
///
/// @param body Pet object in the form of byte array
/// @param body Pet object in the form of byte array (optional)
///
///
/// @return
@ -52,7 +52,7 @@
///
///
/// @param petId Pet id to delete
/// @param apiKey
/// @param apiKey (optional)
///
///
/// @return
@ -66,7 +66,7 @@
/// Finds Pets by status
/// Multiple status values can be provided with comma separated strings
///
/// @param status Status values that need to be considered for query
/// @param status Status values that need to be considered for query (optional) (default to available)
///
///
/// @return NSArray<SWGPet>*
@ -79,7 +79,7 @@
/// Finds Pets by tags
/// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
///
/// @param tags Tags to filter by
/// @param tags Tags to filter by (optional)
///
///
/// @return NSArray<SWGPet>*
@ -131,7 +131,7 @@
/// Update an existing pet
///
///
/// @param body Pet object that needs to be added to the store
/// @param body Pet object that needs to be added to the store (optional)
///
///
/// @return
@ -145,8 +145,8 @@
///
///
/// @param petId ID of pet that needs to be updated
/// @param name Updated name of the pet
/// @param status Updated status of the pet
/// @param name Updated name of the pet (optional)
/// @param status Updated status of the pet (optional)
///
///
/// @return
@ -162,8 +162,8 @@
///
///
/// @param petId ID of pet to update
/// @param additionalMetadata Additional data to pass to server
/// @param file file to upload
/// @param additionalMetadata Additional data to pass to server (optional)
/// @param file file to upload (optional)
///
///
/// @return

4
samples/client/petstore/objc/SwaggerClient/SWGStoreApi.h
View File

@ -37,7 +37,7 @@
/// Finds orders by status
/// A single status value can be provided as a string
///
/// @param status Status value that needs to be considered for query
/// @param status Status value that needs to be considered for query (optional) (default to placed)
///
///
/// @return NSArray<SWGOrder>*
@ -87,7 +87,7 @@
/// Place an order for a pet
///
///
/// @param body order placed for purchasing the pet
/// @param body order placed for purchasing the pet (optional)
///
///
/// @return SWGOrder*

12
samples/client/petstore/objc/SwaggerClient/SWGUserApi.h
View File

@ -24,7 +24,7 @@
/// Create user
/// This can only be done by the logged in user.
///
/// @param body Created user object
/// @param body Created user object (optional)
///
///
/// @return
@ -37,7 +37,7 @@
/// Creates list of users with given input array
///
///
/// @param body List of user object
/// @param body List of user object (optional)
///
///
/// @return
@ -50,7 +50,7 @@
/// Creates list of users with given input array
///
///
/// @param body List of user object
/// @param body List of user object (optional)
///
///
/// @return
@ -89,8 +89,8 @@
/// Logs user into the system
///
///
/// @param username The user name for login
/// @param password The password for login in clear text
/// @param username The user name for login (optional)
/// @param password The password for login in clear text (optional)
///
///
/// @return NSString*
@ -117,7 +117,7 @@
/// This can only be done by the logged in user.
///
/// @param username name that need to be deleted
/// @param body Updated user object
/// @param body Updated user object (optional)
///
///
/// @return