Add XML documentation comments for extension methods

aspnet-contrib · Apr 9, 2016 · 9d07255 · 9d07255
1 parent cfda1a4
commit 9d07255
Show file tree

Hide file tree

Showing 24 changed files with 360 additions and 0 deletions.
diff --git a/src/AspNet.Security.OAuth.ArcGIS/ArcGISAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.ArcGIS/ArcGISAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add ArcGIS authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class ArcGISAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="ArcGISAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables ArcGIS authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="ArcGISAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseArcGISAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] ArcGISAuthenticationOptions options) {
             return app.UseMiddleware<ArcGISAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="ArcGISAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables ArcGIS authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="ArcGISAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseArcGISAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<ArcGISAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.Asana/AsanaAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.Asana/AsanaAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Asana authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class AsanaAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="AsanaAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Asana authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="AsanaAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseAsanaAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] AsanaAuthenticationOptions options) {
             return app.UseMiddleware<AsanaAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="AsanaAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Asana authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="AsanaAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseAsanaAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<AsanaAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.BattleNet/BattleNetAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.BattleNet/BattleNetAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Battle.net authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class BattleNetAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="BattleNetAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Battle.net authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="BattleNetAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseBattleNetAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] BattleNetAuthenticationOptions options) {
             return app.UseMiddleware<BattleNetAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="BattleNetAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Battle.net authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="BattleNetAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseBattleNetAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<BattleNetAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.Beam/BeamAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.Beam/BeamAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Beam authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class BeamAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="BeamAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Beam authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="BeamAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseBeamAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] BeamAuthenticationOptions options) {
             return app.UseMiddleware<BeamAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="BeamAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Beam authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="BeamAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseBeamAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<BeamAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.Buffer/BufferAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.Buffer/BufferAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Buffer authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class BufferAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="BufferAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Buffer authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="BufferAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseBufferAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] BufferAuthenticationOptions options) {
             return app.UseMiddleware<BufferAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="BufferAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Buffer authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="BufferAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseBufferAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<BufferAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.DeviantArt/DeviantArtAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.DeviantArt/DeviantArtAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add DeviantArt authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class DeviantArtAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="DeviantArtAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables DeviantArt authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="DeviantArtAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseDeviantArtAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] DeviantArtAuthenticationOptions options) {
             return app.UseMiddleware<DeviantArtAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="DeviantArtAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables DeviantArt authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="DeviantArtAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseDeviantArtAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<DeviantArtAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.Dropbox/DropboxAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.Dropbox/DropboxAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Dropbox authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class DropboxAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="DropboxAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Dropbox authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="DropboxAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseDropboxAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] DropboxAuthenticationOptions options) {
             return app.UseMiddleware<DropboxAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="DropboxAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Dropbox authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="DropboxAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseDropboxAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<DropboxAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.Fitbit/FitbitAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.Fitbit/FitbitAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Fitbit authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class FitbitAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="FitbitAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Fitbit authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="FitbitAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseFitbitAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] FitbitAuthenticationOptions options) {
             return app.UseMiddleware<FitbitAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="FitbitAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Fitbit authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="FitbitAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseFitbitAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<FitbitAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.Foursquare/FoursquareAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.Foursquare/FoursquareAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add Foursquare authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class FoursquareAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="FoursquareAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Foursquare authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="FoursquareAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseFoursquareAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] FoursquareAuthenticationOptions options) {
             return app.UseMiddleware<FoursquareAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="FoursquareAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables Foursquare authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="FoursquareAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseFoursquareAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<FoursquareAuthenticationOptions> configuration) {

diff --git a/src/AspNet.Security.OAuth.GitHub/GitHubAuthenticationExtensions.cs b/src/AspNet.Security.OAuth.GitHub/GitHubAuthenticationExtensions.cs
@@ -10,13 +10,28 @@
 using Microsoft.Extensions.Options;
 
 namespace Microsoft.AspNetCore.Builder {
+    /// <summary>
+    /// Extension methods to add GitHub authentication capabilities to an HTTP application pipeline.
+    /// </summary>
     public static class GitHubAuthenticationExtensions {
+        /// <summary>
+        /// Adds the <see cref="GitHubAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables GitHub authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="options">A <see cref="GitHubAuthenticationOptions"/> that specifies options for the middleware.</param>        
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseGitHubAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] GitHubAuthenticationOptions options) {
             return app.UseMiddleware<GitHubAuthenticationMiddleware>(Options.Create(options));
         }
 
+        /// <summary>
+        /// Adds the <see cref="GitHubAuthenticationMiddleware"/> middleware to the specified <see cref="IApplicationBuilder"/>, which enables GitHub authentication capabilities.
+        /// </summary>
+        /// <param name="app">The <see cref="IApplicationBuilder"/> to add the middleware to.</param>
+        /// <param name="configuration">An action delegate to configure the provided <see cref="GitHubAuthenticationOptions"/>.</param>
+        /// <returns>A reference to this instance after the operation has completed.</returns>
         public static IApplicationBuilder UseGitHubAuthentication(
             [NotNull] this IApplicationBuilder app,
             [NotNull] Action<GitHubAuthenticationOptions> configuration) {