feat(documentation): Adding model documentation (#4309)

saigiridhar21 · wing328 · commit 73db23a2d773 · 2019-10-30T17:08:33.000+08:00
diff --git a/modules/openapi-generator/src/main/resources/csharp-netcore/model_doc.mustache b/modules/openapi-generator/src/main/resources/csharp-netcore/model_doc.mustache
@@ -1,6 +1,8 @@
 {{#models}}
 {{#model}}
 # {{{packageName}}}.{{modelPackage}}.{{{classname}}}
+{{#description}}{{description}}
+{{/description}}
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/ClassModel.md b/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/ClassModel.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.ClassModel
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/File.md b/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/File.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.File
+Must be named &#x60;File&#x60; for test.
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/Model200Response.md b/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/Model200Response.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.Model200Response
+Model for testing model name starting with number
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/Name.md b/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/Name.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.Name
+Model for testing model name same as property name
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/Return.md b/samples/client/petstore/csharp-netcore/OpenAPIClient/docs/Return.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.Return
+Model for testing reserved words
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/ClassModel.md b/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/ClassModel.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.ClassModel
+Model for testing model with \&quot;_class\&quot; property
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/File.md b/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/File.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.File
+Must be named &#x60;File&#x60; for test.
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/Model200Response.md b/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/Model200Response.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.Model200Response
+Model for testing model name starting with number
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/Name.md b/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/Name.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.Name
+Model for testing model name same as property name
 ## Properties
 
 Name | Type | Description | Notes
diff --git a/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/Return.md b/samples/client/petstore/csharp-netcore/OpenAPIClientCore/docs/Return.md
@@ -1,4 +1,5 @@
 # Org.OpenAPITools.Model.Return
+Model for testing reserved words
 ## Properties
 
 Name | Type | Description | Notes

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Org.OpenAPITools.Model.ClassModel`
	`2`	`+Model for testing model with \"_class\" property`
`2`	`3`	`## Properties`
`3`	`4`
`4`	`5`	`Name \| Type \| Description \| Notes`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Org.OpenAPITools.Model.File`
	`2`	`+Must be named `File` for test.`
`2`	`3`	`## Properties`
`3`	`4`
`4`	`5`	`Name \| Type \| Description \| Notes`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Org.OpenAPITools.Model.Model200Response`
	`2`	`+Model for testing model name starting with number`
`2`	`3`	`## Properties`
`3`	`4`
`4`	`5`	`Name \| Type \| Description \| Notes`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Org.OpenAPITools.Model.Name`
	`2`	`+Model for testing model name same as property name`
`2`	`3`	`## Properties`
`3`	`4`
`4`	`5`	`Name \| Type \| Description \| Notes`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Org.OpenAPITools.Model.Return`
	`2`	`+Model for testing reserved words`
`2`	`3`	`## Properties`
`3`	`4`
`4`	`5`	`Name \| Type \| Description \| Notes`