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

Update Objective-C method description (doc comments) style

Browse Source
This commit is contained in:
geekerzp
2015-06-13 10:48:45 +08:00
parent a6bdc35d59
commit bc92465bf7
8 changed files with 355 additions and 325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
modules/swagger-codegen/src/main/resources/objc/api-body.mustache
View File

@@ -72,14 +72,16 @@ static NSString * basePath = @"{{basePath}}";
return [SWGApiClient requestQueueSize];
}
#pragma mark - Api Methods
{{#operation}}
//
// {{{summary}}}
// {{{notes}}}
// {{#allParams}} @param {{paramName}} {{{description}}}
// {{/allParams}} @returns {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
//
///
/// {{{summary}}}
/// {{{notes}}}
/// {{#allParams}} @param {{paramName}} {{{description}}}
///
/// {{/allParams}} @returns {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
///
-(NSNumber*) {{nickname}}WithCompletionBlock{{^allParams}}: {{/allParams}}{{#allParams}}{{#secondaryParam}} {{paramName}}{{/secondaryParam}}: ({{{dataType}}}) {{paramName}}
{{/allParams}}
{{#returnBaseType}}{{#hasParams}}completionHandler: {{/hasParams}}(void (^)({{{returnType}}} output, NSError* error))completionBlock{{/returnBaseType}}

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

@@ -17,15 +17,15 @@
+(void) setBasePath:(NSString*)basePath;
+(NSString*) getBasePath;
{{#operation}}
//
//
// {{{summary}}}
// {{#notes}}{{{notes}}}{{/notes}}
//
// {{#allParams}}@param {{paramName}} {{description}}
// {{/allParams}}
//
// @return {{{returnType}}}
///
///
/// {{{summary}}}
/// {{#notes}}{{{notes}}}{{/notes}}
///
/// {{#allParams}}@param {{paramName}} {{description}}
/// {{/allParams}}
///
/// @return {{{returnType}}}
-(NSNumber*) {{nickname}}WithCompletionBlock {{^allParams}}:{{/allParams}}{{#allParams}}{{#secondaryParam}} {{paramName}}{{/secondaryParam}}:({{{dataType}}}) {{paramName}} {{#hasMore}}
{{/hasMore}}{{/allParams}}
{{#returnBaseType}}{{#hasParams}}

154
samples/client/petstore/objc/client/SWGPetApi.h
View File

@@ -15,92 +15,92 @@
+(SWGPetApi*) apiWithHeader:(NSString*)headerValue key:(NSString*)key;
+(void) setBasePath:(NSString*)basePath;
+(NSString*) getBasePath;
//
//
// Update an existing pet
//
//
// @param body Pet object that needs to be added to the store
//
//
// @return
///
///
/// Update an existing pet
///
///
/// @param body Pet object that needs to be added to the store
///
///
/// @return
-(NSNumber*) updatePetWithCompletionBlock :(SWGPet*) body
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Add a new pet to the store
//
//
// @param body Pet object that needs to be added to the store
//
//
// @return
///
///
/// Add a new pet to the store
///
///
/// @param body Pet object that needs to be added to the store
///
///
/// @return
-(NSNumber*) addPetWithCompletionBlock :(SWGPet*) body
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Finds Pets by status
// Multiple status values can be provided with comma seperated strings
//
// @param status Status values that need to be considered for filter
//
//
// @return NSArray<SWGPet>*
///
///
/// Finds Pets by status
/// Multiple status values can be provided with comma seperated strings
///
/// @param status Status values that need to be considered for filter
///
///
/// @return NSArray<SWGPet>*
-(NSNumber*) findPetsByStatusWithCompletionBlock :(NSArray*) status
completionHandler: (void (^)(NSArray<SWGPet>* output, NSError* error))completionBlock;
//
//
// 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
//
//
// @return NSArray<SWGPet>*
///
///
/// 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
///
///
/// @return NSArray<SWGPet>*
-(NSNumber*) findPetsByTagsWithCompletionBlock :(NSArray*) tags
completionHandler: (void (^)(NSArray<SWGPet>* output, NSError* error))completionBlock;
//
//
// Find pet by ID
// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
//
// @param petId ID of pet that needs to be fetched
//
//
// @return SWGPet*
///
///
/// Find pet by ID
/// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
///
/// @param petId ID of pet that needs to be fetched
///
///
/// @return SWGPet*
-(NSNumber*) getPetByIdWithCompletionBlock :(NSNumber*) petId
completionHandler: (void (^)(SWGPet* output, NSError* error))completionBlock;
//
//
// Updates a pet in the store with form data
//
//
// @param petId ID of pet that needs to be updated
// @param name Updated name of the pet
// @param status Updated status of the pet
//
//
// @return
///
///
/// Updates a pet in the store with form data
///
///
/// @param petId ID of pet that needs to be updated
/// @param name Updated name of the pet
/// @param status Updated status of the pet
///
///
/// @return
-(NSNumber*) updatePetWithFormWithCompletionBlock :(NSString*) petId
name:(NSString*) name
status:(NSString*) status
@@ -109,16 +109,16 @@
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Deletes a pet
//
//
// @param apiKey
// @param petId Pet id to delete
//
//
// @return
///
///
/// Deletes a pet
///
///
/// @param apiKey
/// @param petId Pet id to delete
///
///
/// @return
-(NSNumber*) deletePetWithCompletionBlock :(NSString*) apiKey
petId:(NSNumber*) petId
@@ -126,17 +126,17 @@
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// uploads an image
//
//
// @param petId ID of pet to update
// @param additionalMetadata Additional data to pass to server
// @param file file to upload
//
//
// @return
///
///
/// uploads an image
///
///
/// @param petId ID of pet to update
/// @param additionalMetadata Additional data to pass to server
/// @param file file to upload
///
///
/// @return
-(NSNumber*) uploadFileWithCompletionBlock :(NSNumber*) petId
additionalMetadata:(NSString*) additionalMetadata
file:(SWGFile*) file

120
samples/client/petstore/objc/client/SWGPetApi.m
View File

@@ -71,13 +71,15 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
return [SWGApiClient requestQueueSize];
}
#pragma mark - Api Methods
//
// Update an existing pet
//
// @param body Pet object that needs to be added to the store
// @returns void
//
///
/// Update an existing pet
///
/// @param body Pet object that needs to be added to the store
///
/// @returns void
///
-(NSNumber*) updatePetWithCompletionBlock: (SWGPet*) body
@@ -168,12 +170,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Add a new pet to the store
//
// @param body Pet object that needs to be added to the store
// @returns void
//
///
/// Add a new pet to the store
///
/// @param body Pet object that needs to be added to the store
///
/// @returns void
///
-(NSNumber*) addPetWithCompletionBlock: (SWGPet*) body
@@ -264,12 +267,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Finds Pets by status
// Multiple status values can be provided with comma seperated strings
// @param status Status values that need to be considered for filter
// @returns NSArray<SWGPet>*
//
///
/// Finds Pets by status
/// Multiple status values can be provided with comma seperated strings
/// @param status Status values that need to be considered for filter
///
/// @returns NSArray<SWGPet>*
///
-(NSNumber*) findPetsByStatusWithCompletionBlock: (NSArray*) status
completionHandler: (void (^)(NSArray<SWGPet>* output, NSError* error))completionBlock
@@ -343,12 +347,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// 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
// @returns NSArray<SWGPet>*
//
///
/// 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
///
/// @returns NSArray<SWGPet>*
///
-(NSNumber*) findPetsByTagsWithCompletionBlock: (NSArray*) tags
completionHandler: (void (^)(NSArray<SWGPet>* output, NSError* error))completionBlock
@@ -422,12 +427,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Find pet by ID
// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
// @param petId ID of pet that needs to be fetched
// @returns SWGPet*
//
///
/// Find pet by ID
/// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
/// @param petId ID of pet that needs to be fetched
///
/// @returns SWGPet*
///
-(NSNumber*) getPetByIdWithCompletionBlock: (NSNumber*) petId
completionHandler: (void (^)(SWGPet* output, NSError* error))completionBlock
@@ -499,14 +505,17 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Updates a pet in the store with form data
//
// @param petId ID of pet that needs to be updated
// @param name Updated name of the pet
// @param status Updated status of the pet
// @returns void
//
///
/// Updates a pet in the store with form data
///
/// @param petId ID of pet that needs to be updated
///
/// @param name Updated name of the pet
///
/// @param status Updated status of the pet
///
/// @returns void
///
-(NSNumber*) updatePetWithFormWithCompletionBlock: (NSString*) petId
name: (NSString*) name
status: (NSString*) status
@@ -596,13 +605,15 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Deletes a pet
//
// @param apiKey
// @param petId Pet id to delete
// @returns void
//
///
/// Deletes a pet
///
/// @param apiKey
///
/// @param petId Pet id to delete
///
/// @returns void
///
-(NSNumber*) deletePetWithCompletionBlock: (NSString*) apiKey
petId: (NSNumber*) petId
@@ -677,14 +688,17 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// uploads an image
//
// @param petId ID of pet to update
// @param additionalMetadata Additional data to pass to server
// @param file file to upload
// @returns void
//
///
/// uploads an image
///
/// @param petId ID of pet to update
///
/// @param additionalMetadata Additional data to pass to server
///
/// @param file file to upload
///
/// @returns void
///
-(NSNumber*) uploadFileWithCompletionBlock: (NSNumber*) petId
additionalMetadata: (NSString*) additionalMetadata
file: (SWGFile*) file

70
samples/client/petstore/objc/client/SWGStoreApi.h
View File

@@ -14,58 +14,58 @@
+(SWGStoreApi*) apiWithHeader:(NSString*)headerValue key:(NSString*)key;
+(void) setBasePath:(NSString*)basePath;
+(NSString*) getBasePath;
//
//
// Returns pet inventories by status
// Returns a map of status codes to quantities
//
//
//
// @return NSDictionary* /* NSString, NSNumber */
///
///
/// Returns pet inventories by status
/// Returns a map of status codes to quantities
///
///
///
/// @return NSDictionary* /* NSString, NSNumber */
-(NSNumber*) getInventoryWithCompletionBlock :
(void (^)(NSDictionary* /* NSString, NSNumber */ output, NSError* error))completionBlock;
//
//
// Place an order for a pet
//
//
// @param body order placed for purchasing the pet
//
//
// @return SWGOrder*
///
///
/// Place an order for a pet
///
///
/// @param body order placed for purchasing the pet
///
///
/// @return SWGOrder*
-(NSNumber*) placeOrderWithCompletionBlock :(SWGOrder*) body
completionHandler: (void (^)(SWGOrder* output, NSError* error))completionBlock;
//
//
// 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
//
//
// @return SWGOrder*
///
///
/// 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
///
///
/// @return SWGOrder*
-(NSNumber*) getOrderByIdWithCompletionBlock :(NSString*) orderId
completionHandler: (void (^)(SWGOrder* output, NSError* error))completionBlock;
//
//
// 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
//
//
// @return
///
///
/// 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
///
///
/// @return
-(NSNumber*) deleteOrderWithCompletionBlock :(NSString*) orderId

50
samples/client/petstore/objc/client/SWGStoreApi.m
View File

@@ -70,12 +70,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
return [SWGApiClient requestQueueSize];
}
#pragma mark - Api Methods
//
// Returns pet inventories by status
// Returns a map of status codes to quantities
// @returns NSDictionary* /* NSString, NSNumber */
//
///
/// Returns pet inventories by status
/// Returns a map of status codes to quantities
/// @returns NSDictionary* /* NSString, NSNumber */
///
-(NSNumber*) getInventoryWithCompletionBlock:
(void (^)(NSDictionary* /* NSString, NSNumber */ output, NSError* error))completionBlock
{
@@ -142,12 +143,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Place an order for a pet
//
// @param body order placed for purchasing the pet
// @returns SWGOrder*
//
///
/// Place an order for a pet
///
/// @param body order placed for purchasing the pet
///
/// @returns SWGOrder*
///
-(NSNumber*) placeOrderWithCompletionBlock: (SWGOrder*) body
completionHandler: (void (^)(SWGOrder* output, NSError* error))completionBlock
@@ -238,12 +240,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// 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
// @returns SWGOrder*
//
///
/// 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
///
/// @returns SWGOrder*
///
-(NSNumber*) getOrderByIdWithCompletionBlock: (NSString*) orderId
completionHandler: (void (^)(SWGOrder* output, NSError* error))completionBlock
@@ -315,12 +318,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// 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
// @returns void
//
///
/// 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
///
/// @returns void
///
-(NSNumber*) deleteOrderWithCompletionBlock: (NSString*) orderId

146
samples/client/petstore/objc/client/SWGUserApi.h
View File

@@ -14,61 +14,61 @@
+(SWGUserApi*) apiWithHeader:(NSString*)headerValue key:(NSString*)key;
+(void) setBasePath:(NSString*)basePath;
+(NSString*) getBasePath;
//
//
// Create user
// This can only be done by the logged in user.
//
// @param body Created user object
//
//
// @return
///
///
/// Create user
/// This can only be done by the logged in user.
///
/// @param body Created user object
///
///
/// @return
-(NSNumber*) createUserWithCompletionBlock :(SWGUser*) body
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Creates list of users with given input array
//
//
// @param body List of user object
//
//
// @return
///
///
/// Creates list of users with given input array
///
///
/// @param body List of user object
///
///
/// @return
-(NSNumber*) createUsersWithArrayInputWithCompletionBlock :(NSArray<SWGUser>*) body
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Creates list of users with given input array
//
//
// @param body List of user object
//
//
// @return
///
///
/// Creates list of users with given input array
///
///
/// @param body List of user object
///
///
/// @return
-(NSNumber*) createUsersWithListInputWithCompletionBlock :(NSArray<SWGUser>*) body
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Logs user into the system
//
//
// @param username The user name for login
// @param password The password for login in clear text
//
//
// @return NSString*
///
///
/// Logs user into the system
///
///
/// @param username The user name for login
/// @param password The password for login in clear text
///
///
/// @return NSString*
-(NSNumber*) loginUserWithCompletionBlock :(NSString*) username
password:(NSString*) password
@@ -76,44 +76,44 @@
//
//
// Logs out current logged in user session
//
//
//
//
// @return
///
///
/// Logs out current logged in user session
///
///
///
///
/// @return
-(NSNumber*) logoutUserWithCompletionBlock :
(void (^)(NSError* error))completionBlock;
//
//
// Get user by user name
//
//
// @param username The name that needs to be fetched. Use user1 for testing.
//
//
// @return SWGUser*
///
///
/// Get user by user name
///
///
/// @param username The name that needs to be fetched. Use user1 for testing.
///
///
/// @return SWGUser*
-(NSNumber*) getUserByNameWithCompletionBlock :(NSString*) username
completionHandler: (void (^)(SWGUser* output, NSError* error))completionBlock;
//
//
// Updated user
// This can only be done by the logged in user.
//
// @param username name that need to be deleted
// @param body Updated user object
//
//
// @return
///
///
/// Updated user
/// This can only be done by the logged in user.
///
/// @param username name that need to be deleted
/// @param body Updated user object
///
///
/// @return
-(NSNumber*) updateUserWithCompletionBlock :(NSString*) username
body:(SWGUser*) body
@@ -121,15 +121,15 @@
completionHandler: (void (^)(NSError* error))completionBlock;
//
//
// Delete user
// This can only be done by the logged in user.
//
// @param username The name that needs to be deleted
//
//
// @return
///
///
/// Delete user
/// This can only be done by the logged in user.
///
/// @param username The name that needs to be deleted
///
///
/// @return
-(NSNumber*) deleteUserWithCompletionBlock :(NSString*) username

108
samples/client/petstore/objc/client/SWGUserApi.m
View File

@@ -70,13 +70,15 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
return [SWGApiClient requestQueueSize];
}
#pragma mark - Api Methods
//
// Create user
// This can only be done by the logged in user.
// @param body Created user object
// @returns void
//
///
/// Create user
/// This can only be done by the logged in user.
/// @param body Created user object
///
/// @returns void
///
-(NSNumber*) createUserWithCompletionBlock: (SWGUser*) body
@@ -167,12 +169,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Creates list of users with given input array
//
// @param body List of user object
// @returns void
//
///
/// Creates list of users with given input array
///
/// @param body List of user object
///
/// @returns void
///
-(NSNumber*) createUsersWithArrayInputWithCompletionBlock: (NSArray<SWGUser>*) body
@@ -263,12 +266,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Creates list of users with given input array
//
// @param body List of user object
// @returns void
//
///
/// Creates list of users with given input array
///
/// @param body List of user object
///
/// @returns void
///
-(NSNumber*) createUsersWithListInputWithCompletionBlock: (NSArray<SWGUser>*) body
@@ -359,13 +363,15 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Logs user into the system
//
// @param username The user name for login
// @param password The password for login in clear text
// @returns NSString*
//
///
/// Logs user into the system
///
/// @param username The user name for login
///
/// @param password The password for login in clear text
///
/// @returns NSString*
///
-(NSNumber*) loginUserWithCompletionBlock: (NSString*) username
password: (NSString*) password
@@ -442,11 +448,11 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Logs out current logged in user session
//
// @returns void
//
///
/// Logs out current logged in user session
///
/// @returns void
///
-(NSNumber*) logoutUserWithCompletionBlock:
(void (^)(NSError* error))completionBlock {
@@ -513,12 +519,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Get user by user name
//
// @param username The name that needs to be fetched. Use user1 for testing.
// @returns SWGUser*
//
///
/// Get user by user name
///
/// @param username The name that needs to be fetched. Use user1 for testing.
///
/// @returns SWGUser*
///
-(NSNumber*) getUserByNameWithCompletionBlock: (NSString*) username
completionHandler: (void (^)(SWGUser* output, NSError* error))completionBlock
@@ -590,13 +597,15 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Updated user
// This can only be done by the logged in user.
// @param username name that need to be deleted
// @param body Updated user object
// @returns void
//
///
/// Updated user
/// This can only be done by the logged in user.
/// @param username name that need to be deleted
///
/// @param body Updated user object
///
/// @returns void
///
-(NSNumber*) updateUserWithCompletionBlock: (NSString*) username
body: (SWGUser*) body
@@ -692,12 +701,13 @@ static NSString * basePath = @"http://petstore.swagger.io/v2";
];
}
//
// Delete user
// This can only be done by the logged in user.
// @param username The name that needs to be deleted
// @returns void
//
///
/// Delete user
/// This can only be done by the logged in user.
/// @param username The name that needs to be deleted
///
/// @returns void
///
-(NSNumber*) deleteUserWithCompletionBlock: (NSString*) username