Fix warning when building because of the missing documentation (#15543)

JFCote · web-flow · commit 842ca3db69c1 · 2023-05-17T00:44:58.000+08:00
diff --git a/modules/openapi-generator/src/main/resources/aspnetcore/3.0/Formatters/InputFormatterStream.mustache b/modules/openapi-generator/src/main/resources/aspnetcore/3.0/Formatters/InputFormatterStream.mustache
@@ -5,15 +5,23 @@ using Microsoft.AspNetCore.Mvc.Formatters;
 
 namespace {{packageName}}.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ namespace {{packageName}}.Formatters
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-3.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-3.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-3.1/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-3.1/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-6.0-pocoModels/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-6.0-pocoModels/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-6.0-project4Models/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-6.0-project4Models/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-6.0-useNewtonsoft/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-6.0-useNewtonsoft/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-6.0-useSwashBuckle/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-6.0-useSwashBuckle/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }
diff --git a/samples/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/samples/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs
@@ -5,15 +5,23 @@
 
 namespace Org.OpenAPITools.Formatters
 {
-    // Input Type Formatter to allow model binding to Streams
+    /// <inheritdoc />
     public class InputFormatterStream : InputFormatter
     {
+        /// <inheritdoc />
         public InputFormatterStream()
         {
             SupportedMediaTypes.Add("application/octet-stream");
             SupportedMediaTypes.Add("image/jpeg");
         }
 
+        /// <inheritdoc />
+        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
+        {
+            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
+        }
+
+        /// <inheritdoc />
         protected override bool CanReadType(Type type)
         {
             if (type == typeof(Stream))
@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)
 
             return false;
         }
-
-        public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)
-        {
-            return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);
-        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,15 +5,23 @@ using Microsoft.AspNetCore.Mvc.Formatters;`
`5`	`5`
`6`	`6`	`namespace {{packageName}}.Formatters`
`7`	`7`	`{`
`8`		`- // Input Type Formatter to allow model binding to Streams`
	`8`	`+ /// <inheritdoc />`
`9`	`9`	`public class InputFormatterStream : InputFormatter`
`10`	`10`	`{`
	`11`	`+ /// <inheritdoc />`
`11`	`12`	`public InputFormatterStream()`
`12`	`13`	`{`
`13`	`14`	`SupportedMediaTypes.Add("application/octet-stream");`
`14`	`15`	`SupportedMediaTypes.Add("image/jpeg");`
`15`	`16`	`}`
`16`	`17`
	`18`	`+ /// <inheritdoc />`
	`19`	`+ public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)`
	`20`	`+ {`
	`21`	`+ return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);`
	`22`	`+ }`
	`23`	`+`
	`24`	`+ /// <inheritdoc />`
`17`	`25`	`protected override bool CanReadType(Type type)`
`18`	`26`	`{`
`19`	`27`	`if (type == typeof(Stream))`
`@@ -23,10 +31,5 @@ namespace {{packageName}}.Formatters`
`23`	`31`
`24`	`32`	`return false;`
`25`	`33`	`}`
`26`		`-`
`27`		`- public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)`
`28`		`- {`
`29`		`- return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);`
`30`		`- }`
`31`	`34`	`}`
`32`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,15 +5,23 @@`
`5`	`5`
`6`	`6`	`namespace Org.OpenAPITools.Formatters`
`7`	`7`	`{`
`8`		`- // Input Type Formatter to allow model binding to Streams`
	`8`	`+ /// <inheritdoc />`
`9`	`9`	`public class InputFormatterStream : InputFormatter`
`10`	`10`	`{`
	`11`	`+ /// <inheritdoc />`
`11`	`12`	`public InputFormatterStream()`
`12`	`13`	`{`
`13`	`14`	`SupportedMediaTypes.Add("application/octet-stream");`
`14`	`15`	`SupportedMediaTypes.Add("image/jpeg");`
`15`	`16`	`}`
`16`	`17`
	`18`	`+ /// <inheritdoc />`
	`19`	`+ public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)`
	`20`	`+ {`
	`21`	`+ return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);`
	`22`	`+ }`
	`23`	`+`
	`24`	`+ /// <inheritdoc />`
`17`	`25`	`protected override bool CanReadType(Type type)`
`18`	`26`	`{`
`19`	`27`	`if (type == typeof(Stream))`
`@@ -23,10 +31,5 @@ protected override bool CanReadType(Type type)`
`23`	`31`
`24`	`32`	`return false;`
`25`	`33`	`}`
`26`		`-`
`27`		`- public override Task<InputFormatterResult> ReadRequestBodyAsync(InputFormatterContext context)`
`28`		`- {`
`29`		`- return InputFormatterResult.SuccessAsync(context.HttpContext.Request.Body);`
`30`		`- }`
`31`	`34`	`}`
`32`	`35`	`}`