Merge pull request #2477 from wing328/csharp_fix_docstring

[C#] minor fix to docstring in csharp
This commit is contained in:
wing328 2016-03-31 17:06:59 +08:00
commit c39bf41d10
13 changed files with 450 additions and 6 deletions

View File

@ -25,6 +25,7 @@ namespace {{packageName}}.Client
/// <param name="tempFolderPath">Temp folder path</param>
/// <param name="dateTimeFormat">DateTime format string</param>
/// <param name="timeout">HTTP connection timeout (in milliseconds)</param>
/// <param name="userAgent">HTTP user agent</param>
public Configuration(ApiClient apiClient = null,
Dictionary<String, String> defaultHeader = null,
string username = null,

View File

@ -1,6 +1,6 @@
public enum {{vendorExtensions.plainDatatypeWithEnum}} {
public enum {{vendorExtensions.plainDatatypeWithEnum}} {
{{#allowableValues}}{{#enumVars}}
[EnumMember(Value = "{{jsonname}}")]
{{name}}{{^-last}},
{{/-last}}{{#-last}}{{/-last}}{{/enumVars}}{{/allowableValues}}
}
}

View File

@ -20,9 +20,13 @@ namespace {{packageName}}.Model
public partial class {{classname}} : {{#parent}}{{{parent}}}, {{/parent}} IEquatable<{{classname}}>
{ {{#vars}}{{#isEnum}}
/// <summary>
/// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}
/// </summary>{{#description}}
/// <value>{{{description}}}</value>{{/description}}
[JsonConverter(typeof(StringEnumConverter))]
{{>enumClass}}{{/isEnum}}{{#items.isEnum}}{{#items}}
{{>enumClass}}{{/items}}{{/items.isEnum}}{{/vars}}
{{>enumClass}}{{/isEnum}}{{#items.isEnum}}{{#items}}
{{>enumClass}}{{/items}}{{/items.isEnum}}{{/vars}}
{{#vars}}{{#isEnum}}
/// <summary>
/// {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{description}}}{{/description}}

View File

@ -60,6 +60,15 @@ namespace IO.Swagger.Test
// TODO: unit test for the property '_Name'
}
/// <summary>
/// Test the property 'SnakeCase'
/// </summary>
[Test]
public void SnakeCaseTest()
{
// TODO: unit test for the property 'SnakeCase'
}
}

View File

@ -25,6 +25,7 @@ namespace IO.Swagger.Client
/// <param name="tempFolderPath">Temp folder path</param>
/// <param name="dateTimeFormat">DateTime format string</param>
/// <param name="timeout">HTTP connection timeout (in milliseconds)</param>
/// <param name="userAgent">HTTP user agent</param>
public Configuration(ApiClient apiClient = null,
Dictionary<String, String> defaultHeader = null,
string username = null,

View File

@ -0,0 +1,121 @@
using System;
using System.Linq;
using System.IO;
using System.Text;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Runtime.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace IO.Swagger.Model
{
/// <summary>
///
/// </summary>
[DataContract]
public partial class Animal : IEquatable<Animal>
{
/// <summary>
/// Initializes a new instance of the <see cref="Animal" /> class.
/// Initializes a new instance of the <see cref="Animal" />class.
/// </summary>
/// <param name="ClassName">ClassName (required).</param>
public Animal(string ClassName = null)
{
// to ensure "ClassName" is required (not null)
if (ClassName == null)
{
throw new InvalidDataException("ClassName is a required property for Animal and cannot be null");
}
else
{
this.ClassName = ClassName;
}
}
/// <summary>
/// Gets or Sets ClassName
/// </summary>
[DataMember(Name="className", EmitDefaultValue=false)]
public string ClassName { get; set; }
/// <summary>
/// Returns the string presentation of the object
/// </summary>
/// <returns>String presentation of the object</returns>
public override string ToString()
{
var sb = new StringBuilder();
sb.Append("class Animal {\n");
sb.Append(" ClassName: ").Append(ClassName).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
/// <summary>
/// Returns the JSON string presentation of the object
/// </summary>
/// <returns>JSON string presentation of the object</returns>
public string ToJson()
{
return JsonConvert.SerializeObject(this, Formatting.Indented);
}
/// <summary>
/// Returns true if objects are equal
/// </summary>
/// <param name="obj">Object to be compared</param>
/// <returns>Boolean</returns>
public override bool Equals(object obj)
{
// credit: http://stackoverflow.com/a/10454552/677735
return this.Equals(obj as Animal);
}
/// <summary>
/// Returns true if Animal instances are equal
/// </summary>
/// <param name="other">Instance of Animal to be compared</param>
/// <returns>Boolean</returns>
public bool Equals(Animal other)
{
// credit: http://stackoverflow.com/a/10454552/677735
if (other == null)
return false;
return
(
this.ClassName == other.ClassName ||
this.ClassName != null &&
this.ClassName.Equals(other.ClassName)
);
}
/// <summary>
/// Gets the hash code
/// </summary>
/// <returns>Hash code</returns>
public override int GetHashCode()
{
// credit: http://stackoverflow.com/a/263416/677735
unchecked // Overflow is fine, just wrap
{
int hash = 41;
// Suitable nullity checks etc, of course :)
if (this.ClassName != null)
hash = hash * 59 + this.ClassName.GetHashCode();
return hash;
}
}
}
}

View File

@ -0,0 +1,138 @@
using System;
using System.Linq;
using System.IO;
using System.Text;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Runtime.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace IO.Swagger.Model
{
/// <summary>
///
/// </summary>
[DataContract]
public partial class Cat : Animal, IEquatable<Cat>
{
/// <summary>
/// Initializes a new instance of the <see cref="Cat" /> class.
/// Initializes a new instance of the <see cref="Cat" />class.
/// </summary>
/// <param name="ClassName">ClassName (required).</param>
/// <param name="Declawed">Declawed.</param>
public Cat(string ClassName = null, bool? Declawed = null)
{
// to ensure "ClassName" is required (not null)
if (ClassName == null)
{
throw new InvalidDataException("ClassName is a required property for Cat and cannot be null");
}
else
{
this.ClassName = ClassName;
}
this.Declawed = Declawed;
}
/// <summary>
/// Gets or Sets ClassName
/// </summary>
[DataMember(Name="className", EmitDefaultValue=false)]
public string ClassName { get; set; }
/// <summary>
/// Gets or Sets Declawed
/// </summary>
[DataMember(Name="declawed", EmitDefaultValue=false)]
public bool? Declawed { get; set; }
/// <summary>
/// Returns the string presentation of the object
/// </summary>
/// <returns>String presentation of the object</returns>
public override string ToString()
{
var sb = new StringBuilder();
sb.Append("class Cat {\n");
sb.Append(" ClassName: ").Append(ClassName).Append("\n");
sb.Append(" Declawed: ").Append(Declawed).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
/// <summary>
/// Returns the JSON string presentation of the object
/// </summary>
/// <returns>JSON string presentation of the object</returns>
public new string ToJson()
{
return JsonConvert.SerializeObject(this, Formatting.Indented);
}
/// <summary>
/// Returns true if objects are equal
/// </summary>
/// <param name="obj">Object to be compared</param>
/// <returns>Boolean</returns>
public override bool Equals(object obj)
{
// credit: http://stackoverflow.com/a/10454552/677735
return this.Equals(obj as Cat);
}
/// <summary>
/// Returns true if Cat instances are equal
/// </summary>
/// <param name="other">Instance of Cat to be compared</param>
/// <returns>Boolean</returns>
public bool Equals(Cat other)
{
// credit: http://stackoverflow.com/a/10454552/677735
if (other == null)
return false;
return
(
this.ClassName == other.ClassName ||
this.ClassName != null &&
this.ClassName.Equals(other.ClassName)
) &&
(
this.Declawed == other.Declawed ||
this.Declawed != null &&
this.Declawed.Equals(other.Declawed)
);
}
/// <summary>
/// Gets the hash code
/// </summary>
/// <returns>Hash code</returns>
public override int GetHashCode()
{
// credit: http://stackoverflow.com/a/263416/677735
unchecked // Overflow is fine, just wrap
{
int hash = 41;
// Suitable nullity checks etc, of course :)
if (this.ClassName != null)
hash = hash * 59 + this.ClassName.GetHashCode();
if (this.Declawed != null)
hash = hash * 59 + this.Declawed.GetHashCode();
return hash;
}
}
}
}

View File

@ -0,0 +1,138 @@
using System;
using System.Linq;
using System.IO;
using System.Text;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Runtime.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
namespace IO.Swagger.Model
{
/// <summary>
///
/// </summary>
[DataContract]
public partial class Dog : Animal, IEquatable<Dog>
{
/// <summary>
/// Initializes a new instance of the <see cref="Dog" /> class.
/// Initializes a new instance of the <see cref="Dog" />class.
/// </summary>
/// <param name="ClassName">ClassName (required).</param>
/// <param name="Breed">Breed.</param>
public Dog(string ClassName = null, string Breed = null)
{
// to ensure "ClassName" is required (not null)
if (ClassName == null)
{
throw new InvalidDataException("ClassName is a required property for Dog and cannot be null");
}
else
{
this.ClassName = ClassName;
}
this.Breed = Breed;
}
/// <summary>
/// Gets or Sets ClassName
/// </summary>
[DataMember(Name="className", EmitDefaultValue=false)]
public string ClassName { get; set; }
/// <summary>
/// Gets or Sets Breed
/// </summary>
[DataMember(Name="breed", EmitDefaultValue=false)]
public string Breed { get; set; }
/// <summary>
/// Returns the string presentation of the object
/// </summary>
/// <returns>String presentation of the object</returns>
public override string ToString()
{
var sb = new StringBuilder();
sb.Append("class Dog {\n");
sb.Append(" ClassName: ").Append(ClassName).Append("\n");
sb.Append(" Breed: ").Append(Breed).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
/// <summary>
/// Returns the JSON string presentation of the object
/// </summary>
/// <returns>JSON string presentation of the object</returns>
public new string ToJson()
{
return JsonConvert.SerializeObject(this, Formatting.Indented);
}
/// <summary>
/// Returns true if objects are equal
/// </summary>
/// <param name="obj">Object to be compared</param>
/// <returns>Boolean</returns>
public override bool Equals(object obj)
{
// credit: http://stackoverflow.com/a/10454552/677735
return this.Equals(obj as Dog);
}
/// <summary>
/// Returns true if Dog instances are equal
/// </summary>
/// <param name="other">Instance of Dog to be compared</param>
/// <returns>Boolean</returns>
public bool Equals(Dog other)
{
// credit: http://stackoverflow.com/a/10454552/677735
if (other == null)
return false;
return
(
this.ClassName == other.ClassName ||
this.ClassName != null &&
this.ClassName.Equals(other.ClassName)
) &&
(
this.Breed == other.Breed ||
this.Breed != null &&
this.Breed.Equals(other.Breed)
);
}
/// <summary>
/// Gets the hash code
/// </summary>
/// <returns>Hash code</returns>
public override int GetHashCode()
{
// credit: http://stackoverflow.com/a/263416/677735
unchecked // Overflow is fine, just wrap
{
int hash = 41;
// Suitable nullity checks etc, of course :)
if (this.ClassName != null)
hash = hash * 59 + this.ClassName.GetHashCode();
if (this.Breed != null)
hash = hash * 59 + this.Breed.GetHashCode();
return hash;
}
}
}
}

View File

@ -18,6 +18,10 @@ namespace IO.Swagger.Model
public partial class InlineResponse200 : IEquatable<InlineResponse200>
{
/// <summary>
/// pet status in the store
/// </summary>
/// <value>pet status in the store</value>
[JsonConverter(typeof(StringEnumConverter))]
public enum StatusEnum {
@ -30,6 +34,7 @@ namespace IO.Swagger.Model
[EnumMember(Value = "sold")]
Sold
}
/// <summary>
/// pet status in the store

View File

@ -23,10 +23,12 @@ namespace IO.Swagger.Model
/// Initializes a new instance of the <see cref="Name" />class.
/// </summary>
/// <param name="_Name">_Name.</param>
/// <param name="SnakeCase">SnakeCase.</param>
public Name(int? _Name = null)
public Name(int? _Name = null, int? SnakeCase = null)
{
this._Name = _Name;
this.SnakeCase = SnakeCase;
}
@ -37,6 +39,12 @@ namespace IO.Swagger.Model
[DataMember(Name="name", EmitDefaultValue=false)]
public int? _Name { get; set; }
/// <summary>
/// Gets or Sets SnakeCase
/// </summary>
[DataMember(Name="snake_case", EmitDefaultValue=false)]
public int? SnakeCase { get; set; }
/// <summary>
/// Returns the string presentation of the object
/// </summary>
@ -46,6 +54,7 @@ namespace IO.Swagger.Model
var sb = new StringBuilder();
sb.Append("class Name {\n");
sb.Append(" _Name: ").Append(_Name).Append("\n");
sb.Append(" SnakeCase: ").Append(SnakeCase).Append("\n");
sb.Append("}\n");
return sb.ToString();
@ -87,6 +96,11 @@ namespace IO.Swagger.Model
this._Name == other._Name ||
this._Name != null &&
this._Name.Equals(other._Name)
) &&
(
this.SnakeCase == other.SnakeCase ||
this.SnakeCase != null &&
this.SnakeCase.Equals(other.SnakeCase)
);
}
@ -105,6 +119,9 @@ namespace IO.Swagger.Model
if (this._Name != null)
hash = hash * 59 + this._Name.GetHashCode();
if (this.SnakeCase != null)
hash = hash * 59 + this.SnakeCase.GetHashCode();
return hash;
}
}

View File

@ -18,6 +18,10 @@ namespace IO.Swagger.Model
public partial class Order : IEquatable<Order>
{
/// <summary>
/// Order Status
/// </summary>
/// <value>Order Status</value>
[JsonConverter(typeof(StringEnumConverter))]
public enum StatusEnum {
@ -30,6 +34,7 @@ namespace IO.Swagger.Model
[EnumMember(Value = "delivered")]
Delivered
}
/// <summary>
/// Order Status

View File

@ -18,6 +18,10 @@ namespace IO.Swagger.Model
public partial class Pet : IEquatable<Pet>
{
/// <summary>
/// pet status in the store
/// </summary>
/// <value>pet status in the store</value>
[JsonConverter(typeof(StringEnumConverter))]
public enum StatusEnum {
@ -30,6 +34,7 @@ namespace IO.Swagger.Model
[EnumMember(Value = "sold")]
Sold
}
/// <summary>
/// pet status in the store

View File

@ -2,7 +2,7 @@
<MonoDevelop.Ide.Workspace ActiveConfiguration="Debug" />
<MonoDevelop.Ide.Workbench ActiveDocument="TestPet.cs">
<Files>
<File FileName="TestPet.cs" Line="218" Column="47" />
<File FileName="TestPet.cs" Line="23" Column="17" />
<File FileName="TestOrder.cs" Line="1" Column="1" />
</Files>
</MonoDevelop.Ide.Workbench>