improve docs (#4097)

304NotModified · web-flow · commit 844a4cfdb405 · 2020-08-23T15:07:34.000+02:00
diff --git a/src/NLog/LayoutRenderers/Wrappers/JsonEncodeLayoutRendererWrapper.cs b/src/NLog/LayoutRenderers/Wrappers/JsonEncodeLayoutRendererWrapper.cs
@@ -74,6 +74,9 @@ public JsonEncodeLayoutRendererWrapper()
         /// <summary>
         /// Should forward slashes be escaped? If true, / will be converted to \/ 
         /// </summary>
+        /// <remarks>
+        /// If not set explicitly then the value of the parent will be used as default.
+        /// </remarks>
         /// <docgen category="Transformation Options" order="10"/>
         [DefaultValue(true)] // TODO NLog 5 change to nullable (with default fallback to false)
         public bool EscapeForwardSlash
diff --git a/src/NLog/Layouts/JsonAttribute.cs b/src/NLog/Layouts/JsonAttribute.cs
@@ -107,8 +107,11 @@ public bool EscapeUnicode
         }
 
         /// <summary>
-        /// Should forward slashes be escaped? If true, / will be converted to \/ 
+        /// Should forward slashes be escaped? If true, / will be converted to \/
         /// </summary>
+        /// <remarks>
+        /// If not set explicitly then the value of the parent will be used as default.
+        /// </remarks>
         /// <docgen category='JSON Attribute Options' order='100' />
         [DefaultValue(true)] // TODO NLog 5 change to nullable (with default fallback to false)
         public bool EscapeForwardSlash 
diff --git a/src/NLog/Layouts/JsonLayout.cs b/src/NLog/Layouts/JsonLayout.cs
@@ -170,6 +170,9 @@ public JsonLayout()
         /// <summary>
         /// Should forward slashes be escaped? If true, / will be converted to \/ 
         /// </summary>
+        /// <remarks>
+        /// If not set explicitly then the value of the parent will be used as default.
+        /// </remarks>
         /// <docgen category='JSON Formating' order='10' />
         [DefaultValue(true)]    // TODO NLog 5 change to nullable (with default fallback to false)
         public bool EscapeForwardSlash
diff --git a/src/NLog/Targets/Wrappers/AutoFlushTargetWrapper.cs b/src/NLog/Targets/Wrappers/AutoFlushTargetWrapper.cs
@@ -67,6 +67,8 @@ public class AutoFlushTargetWrapper : WrapperTargetBase
         /// <summary>
         /// Delay the flush until the LogEvent has been confirmed as written
         /// </summary>
+        /// <remarks>If not explicitly set, then disabled by default for <see cref="BufferingTargetWrapper"/> and AsyncTaskTarget
+        /// </remarks>
         /// <docgen category='General Options' order='10' />
         public bool AsyncFlush
         {

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,8 @@ public class AutoFlushTargetWrapper : WrapperTargetBase`
`67`	`67`	`/// <summary>`
`68`	`68`	`/// Delay the flush until the LogEvent has been confirmed as written`
`69`	`69`	`/// </summary>`
	`70`	`+ /// <remarks>If not explicitly set, then disabled by default for <see cref="BufferingTargetWrapper"/> and AsyncTaskTarget`
	`71`	`+ /// </remarks>`
`70`	`72`	`/// <docgen category='General Options' order='10' />`
`71`	`73`	`public bool AsyncFlush`
`72`	`74`	`{`