MemoryDiagnoserAttribute constructor docs (mostly to rerun CI tests).

timcassell · timcassell · commit c918e150dff0 · 2020-12-13T18:20:52.000-05:00
diff --git a/src/BenchmarkDotNet/Attributes/MemoryDiagnoserAttribute.cs b/src/BenchmarkDotNet/Attributes/MemoryDiagnoserAttribute.cs
@@ -11,6 +11,9 @@ public class MemoryDiagnoserAttribute : Attribute, IConfigSource
 
         public MemoryDiagnoserAttribute() : this(false) { }
 
+        /// <summary>
+        /// If <paramref name="includeSurvived"/> is true, monitoring will be enabled and survived memory will be measured on the first benchmark run.
+        /// </summary>
         public MemoryDiagnoserAttribute(bool includeSurvived)
         {
             Config = ManualConfig.CreateEmpty().AddDiagnoser(includeSurvived ? MemoryDiagnoser.WithSurvived : MemoryDiagnoser.Default);

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@ public class MemoryDiagnoserAttribute : Attribute, IConfigSource`
`11`	`11`
`12`	`12`	`public MemoryDiagnoserAttribute() : this(false) { }`
`13`	`13`
	`14`	`+ /// <summary>`
	`15`	`+ /// If <paramref name="includeSurvived"/> is true, monitoring will be enabled and survived memory will be measured on the first benchmark run.`
	`16`	`+ /// </summary>`
`14`	`17`	`public MemoryDiagnoserAttribute(bool includeSurvived)`
`15`	`18`	`{`
`16`	`19`	`Config = ManualConfig.CreateEmpty().AddDiagnoser(includeSurvived ? MemoryDiagnoser.WithSurvived : MemoryDiagnoser.Default);`