Enable CS1591 errors for undocumented API (#5223)

* Enable CS1591 errors for undocumented API Similar as dotnet/extensions#4230, enable the CS1591 compiler errors when a library generates a documentation file. * Update System.Web.Services.Description.csproj feedback from #5222 * Fix "build -vs" and adding /// comments to Federation --------- Co-authored-by: Matt Connew <mconnew@users.noreply.github.com>
dotnet · Aug 11, 2023 · ec03c30 · ec03c30
1 parent f339387
commit ec03c30
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 2 deletions.
diff --git a/eng/Versions.props b/eng/Versions.props
@@ -13,6 +13,8 @@
     </PreReleaseVersionIteration>
     <!-- Opt-in repo features -->
     <UsingToolIbcOptimization>true</UsingToolIbcOptimization>
+    <!-- Enabling this rule will cause build failures on undocumented public APIs. -->
+    <SkipArcadeNoWarnCS1591>true</SkipArcadeNoWarnCS1591>
   </PropertyGroup>
   <!-- Arcade dependencies -->
   <PropertyGroup>

diff --git a/eng/build.ps1 b/eng/build.ps1
@@ -4,6 +4,7 @@ Param(
   [switch][Alias('b')]$build,
   [switch][Alias('t')]$test,
   [string][Alias('c')]$configuration = "Debug",
+  [string]$vs,
   [string]$os,
   [switch]$coverage,
   [string]$testscope,

diff --git a/...odel.Federation/src/System/ServiceModel/Federation/WSTrustChannelSecurityTokenProvider.cs b/...odel.Federation/src/System/ServiceModel/Federation/WSTrustChannelSecurityTokenProvider.cs
@@ -108,10 +108,13 @@ private void CacheSecurityTokenResponse(WsTrustRequest request, WsTrustResponse
         /// <returns></returns>
         internal virtual ChannelFactory<IRequestChannel> ChannelFactory { get; set; }
 
+        /// <summary>
+        /// Gets or sets the <see cref="ClientCredentials"/> class used by the token provider.
+        /// </summary>
         internal protected ClientCredentials ClientCredentials { get; set; }
 
         /// <summary>
-        /// Creates a <see cref="WsTrustRequest"/> from the <see cref="WSTrustTokenParameters"/>
+        /// Creates a <see cref="WsTrustRequest"/> from the <see cref="WSTrustTokenParameters"/>.
         /// </summary>
         /// <returns></returns>
         protected virtual WsTrustRequest CreateWsTrustRequest()
@@ -436,8 +439,10 @@ private void SetInboundSerializationContext()
             _requestSerializationContext = new WsSerializationContext(GetWsTrustVersion(messageSecurityVersion));
         }
 
+        /// <inheritdoc/>
         public override bool SupportsTokenCancellation => false;
 
+        /// <inheritdoc/>
         public override bool SupportsTokenRenewal => false;
 
         internal WSTrustTokenParameters WSTrustTokenParameters { get; }

diff --git a/...stem.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs b/...stem.ServiceModel.Federation/src/System/ServiceModel/Federation/WsTrustTokenParameters.cs
@@ -21,9 +21,24 @@ namespace System.ServiceModel.Federation
     /// </summary>
     public class WSTrustTokenParameters : IssuedSecurityTokenParameters
     {
+        /// <summary>
+        /// Default value used for <see cref="CacheIssuedTokens"/>.
+        /// </summary>
         public static readonly bool DefaultCacheIssuedTokens = true;
+
+        /// <summary>
+        /// Default value used for <see cref="IssuedTokenRenewalThresholdPercentage"/>.
+        /// </summary>
         public static readonly int DefaultIssuedTokenRenewalThresholdPercentage = 60;
+
+        /// <summary>
+        /// Default value used for <see cref="MaxIssuedTokenCachingTime"/>.
+        /// </summary>
         public static readonly TimeSpan DefaultMaxIssuedTokenCachingTime = TimeSpan.MaxValue;
+
+        /// <summary>
+        /// Default value used for <see cref="IssuedSecurityTokenParameters.KeyType"/> when constructing a WSTrustTokenParameters instance.
+        /// </summary>
         public static readonly SecurityKeyType DefaultSecurityKeyType = SecurityKeyType.SymmetricKey;
 
         private TimeSpan _maxIssuedTokenCachingTime = DefaultMaxIssuedTokenCachingTime;
@@ -157,6 +172,12 @@ public MessageSecurityVersion MessageSecurityVersion
         /// </summary>
         public string RequestContext { get; set; }
 
+        /// <summary>
+        /// Factory method to create a <see cref="WSTrustTokenParameters"/> instance using the same MessageSecurityVersion as WSFederationHttpBinding uses in .NET Framework
+        /// </summary>
+        /// <param name="issuerBinding"></param>
+        /// <param name="issuerAddress"></param>
+        /// <returns></returns>
         public static WSTrustTokenParameters CreateWSFederationTokenParameters(Binding issuerBinding, EndpointAddress issuerAddress)
         {
             return new WSTrustTokenParameters
@@ -169,6 +190,9 @@ public static WSTrustTokenParameters CreateWSFederationTokenParameters(Binding i
             };
         }
 
+        /// <summary>
+        /// Factory method to create a <see cref="WSTrustTokenParameters"/> instance using the same MessageSecurityVersion as WS2007FederationHttpBinding uses in .NET Framework
+        /// </summary>
         public static WSTrustTokenParameters CreateWS2007FederationTokenParameters(Binding issuerBinding, EndpointAddress issuerAddress)
         {
             return new WSTrustTokenParameters

diff --git a/src/System.Web.Services.Description/src/System.Web.Services.Description.csproj b/src/System.Web.Services.Description/src/System.Web.Services.Description.csproj
@@ -8,7 +8,7 @@
     <IsPackable>true</IsPackable>
     <IsShipping>$(Ship_WcfPackages)</IsShipping>
     <TargetFrameworks>netstandard2.0;net461</TargetFrameworks>
-	  <IsPartialFacadeAssembly Condition="'$(TargetFramework)' == 'net461'">true</IsPartialFacadeAssembly>
+    <IsPartialFacadeAssembly Condition="'$(TargetFramework)' == 'net461'">true</IsPartialFacadeAssembly>
     <EnableDefaultItems Condition="'$(TargetFramework)' == 'net461'">false</EnableDefaultItems>
     <PackageDescription>Contains classes that enable you to publicly describe an XML Web service by using the Web Services Description Language (WSDL).</PackageDescription>
   </PropertyGroup>