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

OpenAPITools · May 16, 2023 · 842ca3d · 842ca3d
1 parent 63ac3e1
commit 842ca3d
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 54 deletions.
diff --git a/...napi-generator/src/main/resources/aspnetcore/3.0/Formatters/InputFormatterStream.mustache b/...napi-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/...es/server/petstore/aspnetcore-3.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...es/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/...es/server/petstore/aspnetcore-3.1/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...es/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/...es/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...es/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/...etstore/aspnetcore-6.0-pocoModels/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...etstore/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/...ore/aspnetcore-6.0-project4Models/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...ore/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/...tore/aspnetcore-6.0-useNewtonsoft/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...tore/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/...ore/aspnetcore-6.0-useSwashBuckle/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...ore/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/...es/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/Formatters/InputFormatterStream.cs b/...es/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);
-        }
     }
 }