Skip to content

Commit

Permalink
Added parameter documentation to model constructors (Azure#1184)
Browse files Browse the repository at this point in the history
* Constructor Parameter Documentation for models

* Regenerated files

* Added culture invariant to char.tolower

* Removed unneccessary logic in createsignaturedocumentation

* Removed unneeded null or whitespace check
  • Loading branch information
brnleehng authored and tbombach committed Jun 29, 2016
1 parent ab8f357 commit 592ec93
Show file tree
Hide file tree
Showing 160 changed files with 376 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public Basic() { }
/// <summary>
/// Initializes a new instance of the Basic class.
/// </summary>
/// <param name="color">Possible values include: 'cyan', 'Magenta', 'YELLOW', 'blacK'</param>
public Basic(int? id = default(int?), string name = default(string), string color = default(string))
{
Id = id;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public CatalogArray() { }
/// <summary>
/// Initializes a new instance of the CatalogArray class.
/// </summary>
/// <param name="productArray">Array of products</param>
public CatalogArray(IList<Product> productArray = default(IList<Product>))
{
ProductArray = productArray;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public CatalogArrayOfDictionary() { }
/// <summary>
/// Initializes a new instance of the CatalogArrayOfDictionary class.
/// </summary>
/// <param name="productArrayOfDictionary">Array of dictionary of products</param>
public CatalogArrayOfDictionary(IList<IDictionary<string, Product>> productArrayOfDictionary = default(IList<IDictionary<string, Product>>))
{
ProductArrayOfDictionary = productArrayOfDictionary;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public CatalogDictionary() { }
/// <summary>
/// Initializes a new instance of the CatalogDictionary class.
/// </summary>
/// <param name="productDictionary">Dictionary of products</param>
public CatalogDictionary(IDictionary<string, Product> productDictionary = default(IDictionary<string, Product>))
{
ProductDictionary = productDictionary;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public CatalogDictionaryOfArray() { }
/// <summary>
/// Initializes a new instance of the CatalogDictionaryOfArray class.
/// </summary>
/// <param name="productDictionaryOfArray">Dictionary of Array of product</param>
public CatalogDictionaryOfArray(IDictionary<string, IList<Product>> productDictionaryOfArray = default(IDictionary<string, IList<Product>>))
{
ProductDictionaryOfArray = productDictionaryOfArray;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ public Product() { }
/// <summary>
/// Initializes a new instance of the Product class.
/// </summary>
/// <param name="productId">Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.</param>
/// <param name="description">Description of product.</param>
/// <param name="displayName">Display name of product.</param>
/// <param name="capacity">Capacity of product. For example, 4 people.</param>
/// <param name="image">Image URL representing the product.</param>
public Product(string productId = default(string), string description = default(string), string displayName = default(string), string capacity = default(string), string image = default(string))
{
ProductId = productId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public FirstParameterGroup() { }
/// <summary>
/// Initializes a new instance of the FirstParameterGroup class.
/// </summary>
/// <param name="queryOne">Query parameter with default</param>
public FirstParameterGroup(string headerOne = default(string), int? queryOne = default(int?))
{
HeaderOne = headerOne;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public ParameterGroupingPostMultiParamGroupsSecondParamGroup() { }
/// Initializes a new instance of the
/// ParameterGroupingPostMultiParamGroupsSecondParamGroup class.
/// </summary>
/// <param name="queryTwo">Query parameter with default</param>
public ParameterGroupingPostMultiParamGroupsSecondParamGroup(string headerTwo = default(string), int? queryTwo = default(int?))
{
HeaderTwo = headerTwo;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public ParameterGroupingPostOptionalParameters() { }
/// Initializes a new instance of the
/// ParameterGroupingPostOptionalParameters class.
/// </summary>
/// <param name="query">Query parameter with default</param>
public ParameterGroupingPostOptionalParameters(string customHeader = default(string), int? query = default(int?))
{
CustomHeader = customHeader;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public ParameterGroupingPostRequiredParameters() { }
/// Initializes a new instance of the
/// ParameterGroupingPostRequiredParameters class.
/// </summary>
/// <param name="path">Path parameter</param>
/// <param name="query">Query parameter with default</param>
public ParameterGroupingPostRequiredParameters(int body, string path, string customHeader = default(string), int? query = default(int?))
{
Body = body;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ public FlattenedProduct() { }
/// <summary>
/// Initializes a new instance of the FlattenedProduct class.
/// </summary>
/// <param name="id">Resource Id</param>
/// <param name="type">Resource Type</param>
/// <param name="location">Resource Location</param>
/// <param name="name">Resource Name</param>
public FlattenedProduct(string id = default(string), string type = default(string), IDictionary<string, string> tags = default(IDictionary<string, string>), string location = default(string), string name = default(string), string pname = default(string), int? lsize = default(int?), string provisioningState = default(string))
: base(id, type, tags, location, name)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ public Resource() { }
/// <summary>
/// Initializes a new instance of the Resource class.
/// </summary>
/// <param name="id">Resource Id</param>
/// <param name="type">Resource Type</param>
/// <param name="location">Resource Location</param>
/// <param name="name">Resource Name</param>
public Resource(string id = default(string), string type = default(string), IDictionary<string, string> tags = default(IDictionary<string, string>), string location = default(string), string name = default(string))
{
Id = id;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public HeaderCustomNamedRequestIdHeaders() { }
/// Initializes a new instance of the
/// HeaderCustomNamedRequestIdHeaders class.
/// </summary>
/// <param name="fooRequestId">Gets the foo-request-id.</param>
public HeaderCustomNamedRequestIdHeaders(string fooRequestId = default(string))
{
FooRequestId = fooRequestId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public HeaderCustomNamedRequestIdParamGroupingHeaders() { }
/// Initializes a new instance of the
/// HeaderCustomNamedRequestIdParamGroupingHeaders class.
/// </summary>
/// <param name="fooRequestId">Gets the foo-request-id.</param>
public HeaderCustomNamedRequestIdParamGroupingHeaders(string fooRequestId = default(string))
{
FooRequestId = fooRequestId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public HeaderCustomNamedRequestIdParamGroupingParameters() { }
/// Initializes a new instance of the
/// HeaderCustomNamedRequestIdParamGroupingParameters class.
/// </summary>
/// <param name="fooClientRequestId">The fooRequestId</param>
public HeaderCustomNamedRequestIdParamGroupingParameters(string fooClientRequestId)
{
FooClientRequestId = fooClientRequestId;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LRORetrysDelete202Retry200Headers() { }
/// Initializes a new instance of the
/// LRORetrysDelete202Retry200Headers class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/delete/202/retry/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LRORetrysDelete202Retry200Headers(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LRORetrysDeleteAsyncRelativeRetrySucceededHeaders() { }
/// Initializes a new instance of the
/// LRORetrysDeleteAsyncRelativeRetrySucceededHeaders class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/retryerror/deleteasync/retry/succeeded/operationResults/200</param>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/deleteasync/retry/succeeded/operationResults/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LRORetrysDeleteAsyncRelativeRetrySucceededHeaders(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ public LRORetrysDeleteProvisioning202Accepted200SucceededHeaders() { }
/// Initializes a new instance of the
/// LRORetrysDeleteProvisioning202Accepted200SucceededHeaders class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/delete/provisioning/202/accepted/200/succeeded</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LRORetrysDeleteProvisioning202Accepted200SucceededHeaders(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LRORetrysPost202Retry200Headers() { }
/// Initializes a new instance of the LRORetrysPost202Retry200Headers
/// class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/post/202/retry/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LRORetrysPost202Retry200Headers(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LRORetrysPostAsyncRelativeRetrySucceededHeaders() { }
/// Initializes a new instance of the
/// LRORetrysPostAsyncRelativeRetrySucceededHeaders class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/retryerror/putasync/retry/succeeded/operationResults/200</param>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/putasync/retry/succeeded/operationResults/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LRORetrysPostAsyncRelativeRetrySucceededHeaders(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LRORetrysPutAsyncRelativeRetrySucceededHeaders() { }
/// Initializes a new instance of the
/// LRORetrysPutAsyncRelativeRetrySucceededHeaders class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/retryerror/putasync/retry/succeeded/operationResults/200</param>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/putasync/retry/succeeded/operationResults/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LRORetrysPutAsyncRelativeRetrySucceededHeaders(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LROSADsDelete202NonRetry400Headers() { }
/// Initializes a new instance of the
/// LROSADsDelete202NonRetry400Headers class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/delete/202/retry/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsDelete202NonRetry400Headers(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LROSADsDelete202RetryInvalidHeaderHeaders() { }
/// Initializes a new instance of the
/// LROSADsDelete202RetryInvalidHeaderHeaders class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /foo</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to /bar</param>
public LROSADsDelete202RetryInvalidHeaderHeaders(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LROSADsDeleteAsyncRelativeRetry400Headers() { }
/// Initializes a new instance of the
/// LROSADsDeleteAsyncRelativeRetry400Headers class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/nonretryerror/deleteasync/retry/operationResults/400</param>
/// <param name="location">Location to poll for result status: will be set to /lro/nonretryerror/deleteasync/retry/operationResults/400</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsDeleteAsyncRelativeRetry400Headers(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LROSADsDeleteAsyncRelativeRetryInvalidHeaderHeaders() { }
/// Initializes a new instance of the
/// LROSADsDeleteAsyncRelativeRetryInvalidHeaderHeaders class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /foo</param>
/// <param name="location">Location to poll for result status: will be set to /foo</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to /bar</param>
public LROSADsDeleteAsyncRelativeRetryInvalidHeaderHeaders(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ public LROSADsDeleteAsyncRelativeRetryInvalidJsonPollingHeaders() { }
/// Initializes a new instance of the
/// LROSADsDeleteAsyncRelativeRetryInvalidJsonPollingHeaders class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/error/deleteasync/retry/failed/operationResults/invalidjsonpolling</param>
/// <param name="location">Location to poll for result status: will be set to /lro/error/deleteasync/retry/failed/operationResults/invalidjsonpolling</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsDeleteAsyncRelativeRetryInvalidJsonPollingHeaders(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LROSADsDeleteAsyncRelativeRetryNoStatusHeaders() { }
/// Initializes a new instance of the
/// LROSADsDeleteAsyncRelativeRetryNoStatusHeaders class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/deleteasync/retry/succeeded/operationResults/200</param>
/// <param name="location">Location to poll for result status: will be set to /lro/deleteasync/retry/succeeded/operationResults/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsDeleteAsyncRelativeRetryNoStatusHeaders(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LROSADsDeleteNonRetry400Headers() { }
/// Initializes a new instance of the LROSADsDeleteNonRetry400Headers
/// class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/delete/202/retry/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsDeleteNonRetry400Headers(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LROSADsPost202NoLocationHeaders() { }
/// Initializes a new instance of the LROSADsPost202NoLocationHeaders
/// class.
/// </summary>
/// <param name="location">Location to poll for result status: will not be set</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsPost202NoLocationHeaders(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LROSADsPost202NonRetry400Headers() { }
/// Initializes a new instance of the LROSADsPost202NonRetry400Headers
/// class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /lro/retryerror/post/202/retry/200</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsPost202NonRetry400Headers(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ public LROSADsPost202RetryInvalidHeaderHeaders() { }
/// Initializes a new instance of the
/// LROSADsPost202RetryInvalidHeaderHeaders class.
/// </summary>
/// <param name="location">Location to poll for result status: will be set to /foo</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to /bar</param>
public LROSADsPost202RetryInvalidHeaderHeaders(string location = default(string), int? retryAfter = default(int?))
{
Location = location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ public LROSADsPostAsyncRelativeRetry400Headers() { }
/// Initializes a new instance of the
/// LROSADsPostAsyncRelativeRetry400Headers class.
/// </summary>
/// <param name="azureAsyncOperation">Location to poll for result status: will be set to /lro/nonretryerror/putasync/retry/operationResults/400</param>
/// <param name="location">Location to poll for result status: will be set to /lro/nonretryerror/putasync/retry/operationResults/400</param>
/// <param name="retryAfter">Number of milliseconds until the next poll should be sent, will be set to zero</param>
public LROSADsPostAsyncRelativeRetry400Headers(string azureAsyncOperation = default(string), string location = default(string), int? retryAfter = default(int?))
{
AzureAsyncOperation = azureAsyncOperation;
Expand Down
Loading

0 comments on commit 592ec93

Please sign in to comment.