Docs for preferring RenderLogEvent on Target (#4947)

Co-authored-by: Julian Verdurmen <304NotModified@users.noreply.github.com>
NLog · Jun 27, 2022 · cb1df12 · cb1df12
1 parent c0948dd
commit cb1df12
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/src/NLog/Layouts/Layout.cs b/src/NLog/Layouts/Layout.cs
@@ -41,6 +41,7 @@ namespace NLog.Layouts
     using NLog.Config;
     using NLog.Internal;
     using NLog.Common;
+    using NLog.Targets;
     using JetBrains.Annotations;
 
     /// <summary>
@@ -189,6 +190,7 @@ public virtual void Precalculate(LogEventInfo logEvent)
         /// <summary>
         /// Renders formatted output using the log event as context.
         /// </summary>
+        /// <remarks>Inside a <see cref="Target"/>, <see cref="Target.RenderLogEvent"/> is preferred for performance reasons.</remarks>
         /// <param name="logEvent">The logging event.</param>
         /// <returns>The formatted output as string.</returns>
         public string Render(LogEventInfo logEvent)

diff --git a/src/NLog/Layouts/Typed/LayoutTypedExtensions.cs b/src/NLog/Layouts/Typed/LayoutTypedExtensions.cs
@@ -33,6 +33,7 @@
 
 using JetBrains.Annotations;
 using NLog.Layouts;
+using NLog.Targets;
 
 namespace NLog
 {
@@ -44,6 +45,7 @@ public static class LayoutTypedExtensions
         /// <summary>
         /// Renders the logevent into a result-value by using the provided layout
         /// </summary>
+        /// <remarks>Inside a <see cref="Target"/>, <see cref="Target.RenderLogEvent"/> is preferred for performance reasons.</remarks>
         /// <typeparam name="T"></typeparam>
         /// <param name="layout">The layout.</param>
         /// <param name="logEvent">The logevent info.</param>