Skip to content

Commit

Permalink
Merge pull request Azure#1035 from brnleehng/feature/doc-strings-1
Browse files Browse the repository at this point in the history
Added "gets or sets" rule for the CSharp model template
  • Loading branch information
tbombach committed May 13, 2016
2 parents a30c462 + dcdca06 commit 68b02be
Show file tree
Hide file tree
Showing 189 changed files with 699 additions and 545 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ public Basic(int? id = default(int?), string name = default(string), string colo
public string Name { get; set; }

/// <summary>
/// Possible values include: 'cyan', 'Magenta', 'YELLOW', 'blacK'
/// Gets or sets possible values include: 'cyan', 'Magenta', 'YELLOW',
/// 'blacK'
/// </summary>
[JsonProperty(PropertyName = "color")]
public string Color { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public CatalogArray(IList<Product> productArray = default(IList<Product>))
}

/// <summary>
/// Array of products
/// Gets or sets array of products
/// </summary>
[JsonProperty(PropertyName = "productArray")]
public IList<Product> ProductArray { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public CatalogArrayOfDictionary(IList<IDictionary<string, Product>> productArray
}

/// <summary>
/// Array of dictionary of products
/// Gets or sets array of dictionary of products
/// </summary>
[JsonProperty(PropertyName = "productArrayOfDictionary")]
public IList<IDictionary<string, Product>> ProductArrayOfDictionary { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public CatalogDictionary(IDictionary<string, Product> productDictionary = defaul
}

/// <summary>
/// Dictionary of products
/// Gets or sets dictionary of products
/// </summary>
[JsonProperty(PropertyName = "productDictionary")]
public IDictionary<string, Product> ProductDictionary { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public CatalogDictionaryOfArray(IDictionary<string, IList<Product>> productDicti
}

/// <summary>
/// Dictionary of Array of product
/// Gets or sets dictionary of Array of product
/// </summary>
[JsonProperty(PropertyName = "productDictionaryOfArray")]
public IDictionary<string, IList<Product>> ProductDictionaryOfArray { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,33 +39,34 @@ public Product(string productId = default(string), string description = default(
}

/// <summary>
/// Unique identifier representing a specific product for a given
/// latitude &amp; longitude. For example, uberX in San Francisco
/// will have a different product_id than uberX in Los Angeles.
/// Gets or sets unique identifier representing a specific product for
/// a given latitude &amp; longitude. For example, uberX in San
/// Francisco will have a different product_id than uberX in Los
/// Angeles.
/// </summary>
[JsonProperty(PropertyName = "product_id")]
public string ProductId { get; set; }

/// <summary>
/// Description of product.
/// Gets or sets description of product.
/// </summary>
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

/// <summary>
/// Display name of product.
/// Gets or sets display name of product.
/// </summary>
[JsonProperty(PropertyName = "display_name")]
public string DisplayName { get; set; }

/// <summary>
/// Capacity of product. For example, 4 people.
/// Gets or sets capacity of product. For example, 4 people.
/// </summary>
[JsonProperty(PropertyName = "capacity")]
public string Capacity { get; set; }

/// <summary>
/// Image URL representing the product.
/// Gets or sets image URL representing the product.
/// </summary>
[JsonProperty(PropertyName = "image")]
public string Image { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Fixtures.Azure.AcceptanceTestsAzureParameterGrouping.Models
using Microsoft.Rest.Azure;

/// <summary>
/// Additional parameters for the postMultiParamGroups operation.
/// Additional parameters for one or more operations
/// </summary>
public partial class FirstParameterGroup
{
Expand All @@ -41,7 +41,7 @@ public FirstParameterGroup(string headerOne = default(string), int? queryOne = d
public string HeaderOne { get; set; }

/// <summary>
/// Query parameter with default
/// Gets or sets query parameter with default
/// </summary>
[JsonProperty(PropertyName = "")]
public int? QueryOne { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Fixtures.Azure.AcceptanceTestsAzureParameterGrouping.Models
using Microsoft.Rest.Azure;

/// <summary>
/// Additional parameters for the postMultiParamGroups operation.
/// Additional parameters for one or more operations
/// </summary>
public partial class ParameterGroupingPostMultiParamGroupsSecondParamGroup
{
Expand All @@ -43,7 +43,7 @@ public ParameterGroupingPostMultiParamGroupsSecondParamGroup(string headerTwo =
public string HeaderTwo { get; set; }

/// <summary>
/// Query parameter with default
/// Gets or sets query parameter with default
/// </summary>
[JsonProperty(PropertyName = "")]
public int? QueryTwo { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Fixtures.Azure.AcceptanceTestsAzureParameterGrouping.Models
using Microsoft.Rest.Azure;

/// <summary>
/// Additional parameters for the postOptional operation.
/// Additional parameters for one or more operations
/// </summary>
public partial class ParameterGroupingPostOptionalParameters
{
Expand All @@ -43,7 +43,7 @@ public ParameterGroupingPostOptionalParameters(string customHeader = default(str
public string CustomHeader { get; set; }

/// <summary>
/// Query parameter with default
/// Gets or sets query parameter with default
/// </summary>
[JsonProperty(PropertyName = "")]
public int? Query { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace Fixtures.Azure.AcceptanceTestsAzureParameterGrouping.Models
using Microsoft.Rest.Azure;

/// <summary>
/// Additional parameters for the postRequired operation.
/// Additional parameters for one or more operations
/// </summary>
public partial class ParameterGroupingPostRequiredParameters
{
Expand Down Expand Up @@ -50,13 +50,13 @@ public ParameterGroupingPostRequiredParameters(int body, string path, string cus
public string CustomHeader { get; set; }

/// <summary>
/// Query parameter with default
/// Gets or sets query parameter with default
/// </summary>
[JsonProperty(PropertyName = "")]
public int? Query { get; set; }

/// <summary>
/// Path parameter
/// Gets or sets path parameter
/// </summary>
[JsonProperty(PropertyName = "")]
public string Path { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ public Resource(string id = default(string), string type = default(string), IDic
}

/// <summary>
/// Resource Id
/// Gets resource Id
/// </summary>
[JsonProperty(PropertyName = "id")]
public string Id { get; private set; }

/// <summary>
/// Resource Type
/// Gets resource Type
/// </summary>
[JsonProperty(PropertyName = "type")]
public string Type { get; private set; }
Expand All @@ -53,13 +53,13 @@ public Resource(string id = default(string), string type = default(string), IDic
public IDictionary<string, string> Tags { get; set; }

/// <summary>
/// Resource Location
/// Gets or sets resource Location
/// </summary>
[JsonProperty(PropertyName = "location")]
public string Location { get; set; }

/// <summary>
/// Resource Name
/// Gets resource Name
/// </summary>
[JsonProperty(PropertyName = "name")]
public string Name { get; private set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public HeaderCustomNamedRequestIdHeaders(string fooRequestId = default(string))
}

/// <summary>
/// Gets the foo-request-id.
/// Gets or sets gets the foo-request-id.
/// </summary>
[JsonProperty(PropertyName = "foo-request-id")]
public string FooRequestId { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ public LRORetrysDelete202Retry200Headers(string location = default(string), int?
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/delete/202/retry/200
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ public LRORetrysDeleteAsyncRelativeRetrySucceededHeaders(string azureAsyncOperat
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/deleteasync/retry/succeeded/operationResults/200
/// </summary>
[JsonProperty(PropertyName = "Azure-AsyncOperation")]
public string AzureAsyncOperation { get; set; }

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/deleteasync/retry/succeeded/operationResults/200
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ public LRORetrysDeleteProvisioning202Accepted200SucceededHeaders(string location
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/delete/provisioning/202/accepted/200/succeeded
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ public LRORetrysPost202Retry200Headers(string location = default(string), int? r
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/post/202/retry/200
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ public LRORetrysPostAsyncRelativeRetrySucceededHeaders(string azureAsyncOperatio
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/putasync/retry/succeeded/operationResults/200
/// </summary>
[JsonProperty(PropertyName = "Azure-AsyncOperation")]
public string AzureAsyncOperation { get; set; }

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/putasync/retry/succeeded/operationResults/200
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ public LRORetrysPutAsyncRelativeRetrySucceededHeaders(string azureAsyncOperation
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/putasync/retry/succeeded/operationResults/200
/// </summary>
[JsonProperty(PropertyName = "Azure-AsyncOperation")]
public string AzureAsyncOperation { get; set; }

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/putasync/retry/succeeded/operationResults/200
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ public LROSADsDelete202NonRetry400Headers(string location = default(string), int
}

/// <summary>
/// Location to poll for result status: will be set to
/// Gets or sets location to poll for result status: will be set to
/// /lro/retryerror/delete/202/retry/200
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to zero
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to zero
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,15 @@ public LROSADsDelete202RetryInvalidHeaderHeaders(string location = default(strin
}

/// <summary>
/// Location to poll for result status: will be set to /foo
/// Gets or sets location to poll for result status: will be set to
/// /foo
/// </summary>
[JsonProperty(PropertyName = "Location")]
public string Location { get; set; }

/// <summary>
/// Number of milliseconds until the next poll should be sent, will be
/// set to /bar
/// Gets or sets number of milliseconds until the next poll should be
/// sent, will be set to /bar
/// </summary>
[JsonProperty(PropertyName = "Retry-After")]
public int? RetryAfter { get; set; }
Expand Down

0 comments on commit 68b02be

Please sign in to comment.