Update docs that Dispose does not save the content if AutoSave property is false (dotnet#1873)

mikeebowen · web-flow · commit c3111048ed30 · 2025-03-10T11:21:50.000-07:00
Fixes dotnet#1527
diff --git a/src/DocumentFormat.OpenXml.Framework/Packaging/OpenXmlPackage.cs b/src/DocumentFormat.OpenXml.Framework/Packaging/OpenXmlPackage.cs
@@ -262,7 +262,7 @@ protected override void ThrowIfObjectDisposed()
         }
 
         /// <summary>
-        /// Flushes and saves the content, closes the document, and releases all resources.
+        /// Flushes the content, closes the document, and releases all resources. If the <see cref="OpenXmlPackage.AutoSave" /> property is <c>true</c>, the content will be saved before closing.
         /// </summary>
         /// <param name="disposing">Specify true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)

Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ protected override void ThrowIfObjectDisposed()`
`262`	`262`	`}`
`263`	`263`
`264`	`264`	`/// <summary>`
`265`		`- /// Flushes and saves the content, closes the document, and releases all resources.`
	`265`	`+ /// Flushes the content, closes the document, and releases all resources. If the <see cref="OpenXmlPackage.AutoSave" /> property is <c>true</c>, the content will be saved before closing.`
`266`	`266`	`/// </summary>`
`267`	`267`	`/// <param name="disposing">Specify true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>`
`268`	`268`	`protected virtual void Dispose(bool disposing)`