Fix some doc xref issues (#4791)

Co-authored-by: Martin Taillefer <[email protected]>
dotnet · Dec 6, 2023 · 76d601e · 76d601e
1 parent 83610d7
commit 76d601e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 12 deletions.
diff --git a/...aries/Microsoft.Extensions.Telemetry.Abstractions/Http/HttpRouteParameterRedactionMode.cs b/...aries/Microsoft.Extensions.Telemetry.Abstractions/Http/HttpRouteParameterRedactionMode.cs
@@ -11,17 +11,11 @@ public enum HttpRouteParameterRedactionMode
     /// <summary>
     /// All parameters are considered as sensitive and are required to be explicitly annotated with a data classification.
     /// </summary>
-    /// <remarks>
-    /// Unannotated parameters are always redacted with the erasing redactor.
-    /// </remarks>
     Strict,
 
     /// <summary>
     /// All parameters are considered as non-sensitive and included as-is by default.
     /// </summary>
-    /// <remarks>
-    /// Only parameters explicitly annotated with a data classification are redacted.
-    /// </remarks>
     Loose,
 
     /// <summary>

diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyConsoleExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyConsoleExtensions.cs
@@ -20,7 +20,7 @@ public static class LatencyConsoleExtensions
     /// Add latency data exporter for the console.
     /// </summary>
     /// <param name="services">Dependency injection container.</param>
-    /// <returns>Provided service collection with <see cref="LatencyConsoleExporter"/> added.</returns>
+    /// <returns>The value of <paramref name="services" />.</returns>
     /// <exception cref="ArgumentNullException"><paramref name="services"/> is <see langword="null"/>.</exception>
     public static IServiceCollection AddConsoleLatencyDataExporter(this IServiceCollection services)
     {
@@ -37,7 +37,7 @@ public static IServiceCollection AddConsoleLatencyDataExporter(this IServiceColl
     /// </summary>
     /// <param name="services">Dependency injection container.</param>
     /// <param name="configure"><see cref="LatencyConsoleOptions"/> configuration delegate.</param>
-    /// <returns>Provided service collection with <see cref="LatencyConsoleExporter"/> added.</returns>
+    /// <returns>The value of <paramref name="services" />.</returns>
     /// <exception cref="ArgumentNullException">Either <paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
     public static IServiceCollection AddConsoleLatencyDataExporter(this IServiceCollection services, Action<LatencyConsoleOptions> configure)
     {
@@ -54,7 +54,7 @@ public static IServiceCollection AddConsoleLatencyDataExporter(this IServiceColl
     /// </summary>
     /// <param name="services">Dependency injection container.</param>
     /// <param name="section">Configuration of <see cref="LatencyConsoleOptions"/>.</param>
-    /// <returns>Provided service collection with <see cref="LatencyConsoleExporter"/> added.</returns>
+    /// <returns>The value of <paramref name="services" />.</returns>
     /// <exception cref="ArgumentNullException">Either <paramref name="services"/> or <paramref name="section"/> is <see langword="null"/>.</exception>
     [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(LatencyConsoleOptions))]
     [UnconditionalSuppressMessage(

diff --git a/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyContextExtensions.cs b/src/Libraries/Microsoft.Extensions.Telemetry/Latency/LatencyContextExtensions.cs
@@ -20,7 +20,7 @@ public static class LatencyContextExtensions
     /// Adds latency context.
     /// </summary>
     /// <param name="services">The dependency injection container.</param>
-    /// <returns>The provided service collection with <see cref="ILatencyContext"/> added.</returns>
+    /// <returns>The value of <paramref name="services" />.</returns>
     public static IServiceCollection AddLatencyContext(this IServiceCollection services)
     {
         _ = Throw.IfNull(services);
@@ -37,7 +37,7 @@ public static IServiceCollection AddLatencyContext(this IServiceCollection servi
     /// </summary>
     /// <param name="services">The dependency injection container.</param>
     /// <param name="configure">The <see cref="LatencyContextOptions"/> configuration delegate.</param>
-    /// <returns>The provided service collection with <see cref="LatencyContextProvider"/> added.</returns>
+    /// <returns>The value of <paramref name="services" />.</returns>
     public static IServiceCollection AddLatencyContext(this IServiceCollection services, Action<LatencyContextOptions> configure)
     {
         _ = Throw.IfNull(services);
@@ -53,7 +53,7 @@ public static IServiceCollection AddLatencyContext(this IServiceCollection servi
     /// </summary>
     /// <param name="services">The dependency injection container.</param>
     /// <param name="section">The configuration of <see cref="LatencyContextOptions"/>.</param>
-    /// <returns>The provided service collection with <see cref="LatencyContextProvider"/> added.</returns>
+    /// <returns>The value of <paramref name="services" />.</returns>
     [DynamicDependency(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicParameterlessConstructor, typeof(LatencyContextOptions))]
     [UnconditionalSuppressMessage(
         "Trimming",