Fix xmldoc, add ObsoleteAttribute

Author: angularsen

src/Serilog.Extensions.Hosting/Extensions/Hosting/DiagnosticContextCollector.cs

@@ -40,7 +40,7 @@ public void AddOrUpdate(LogEventProperty property)
         }
 
         /// <summary>
-        /// Set an exception to include in the Serilog request log event.
+        /// Set the exception associated with the current diagnostic context.
         /// </summary>
         /// <example>
         /// Passing an exception to the diagnostic context is useful when unhandled exceptions are handled before reaching Serilog's
@@ -69,6 +69,7 @@ public void SetException(Exception exception)
         /// <param name="properties">The collected properties, or null if no collection is active.</param>
         /// <returns>True if properties could be collected.</returns>
         /// <seealso cref="IDiagnosticContext.Set"/>
+        [Obsolete("Replaced by TryComplete(out IEnumerable<LogEventProperty> properties, out Exception exception).")]
         public bool TryComplete(out IEnumerable<LogEventProperty> properties)
         {
             return TryComplete(out properties, out _);

src/Serilog.Extensions.Hosting/IDiagnosticContext.cs

@@ -33,15 +33,13 @@ public interface IDiagnosticContext
 
         /// <summary>
         /// Set the specified exception on the current diagnostic context.
-        /// <br/><br/>
-        /// This is useful when unhandled exceptions do not reach <c>Serilog.AspNetCore.RequestLoggingMiddleware</c>,
-        /// such as when using <a href="https://www.nuget.org/packages/Hellang.Middleware.ProblemDetails">Hellang.Middleware.ProblemDetails</a>
-        /// to transform exceptions to ProblemDetails responses.
         /// </summary>
         /// <remarks>
-        /// If <c>null</c> is given, it clears any previously assigned exception.
+        /// This method is useful when unhandled exceptions do not reach <c>Serilog.AspNetCore.RequestLoggingMiddleware</c>,
+        /// such as when using <a href="https://www.nuget.org/packages/Hellang.Middleware.ProblemDetails">Hellang.Middleware.ProblemDetails</a>
+        /// to transform exceptions to ProblemDetails responses.
         /// </remarks>
-        /// <param name="exception">The exception to log.</param>
+        /// <param name="exception">The exception to log. If <c>null</c> is given, it clears any previously assigned exception.</param>
         void SetException(Exception exception);
     }
 }