Skip to content

Commit f31a3ee

Browse files
LodrKumquatiText-CI
authored andcommitted
Add documentation to PdfReader#setMemorySavingMode()
DEVSIX-3594 Autoported commit. Original commit hash: [27da233cc]
1 parent bd44b4d commit f31a3ee

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

itext/itext.kernel/itext/kernel/pdf/PdfReader.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,20 @@ public virtual iText.Kernel.Pdf.PdfReader SetUnethicalReading(bool unethicalRead
182182
return this;
183183
}
184184

185+
/// <summary>Defines if memory saving mode is enabled.</summary>
186+
/// <remarks>
187+
/// Defines if memory saving mode is enabled.
188+
/// <para />
189+
/// By default memory saving mode is disabled for the sake of time–memory trade-off.
190+
/// <para />
191+
/// If memory saving mode is enabled, document processing might slow down, but reading will be less memory demanding.
192+
/// </remarks>
193+
/// <param name="memorySavingMode">true to enable memory saving mode, false to disable it.</param>
194+
/// <returns>
195+
/// this
196+
/// <see cref="PdfReader"/>
197+
/// instance.
198+
/// </returns>
185199
public virtual iText.Kernel.Pdf.PdfReader SetMemorySavingMode(bool memorySavingMode) {
186200
this.memorySavingMode = memorySavingMode;
187201
return this;

port-hash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
42607624c57c522a4ec4b8283a9ba6901fa8af3f
1+
27da233cc00f3e511bc8b29060540f5a53004aa5

0 commit comments

Comments
 (0)