Browse Source

Adjusted xml documentation

Marcin Ziąbek 2 years ago
parent
commit
5d2d97097c

+ 4 - 4
Source/QuestPDF/Fluent/ImageExtensions.cs

@@ -35,7 +35,7 @@ namespace QuestPDF.Fluent
         /// The DPI (pixels-per-inch) at which images and features without native PDF support will be rasterized.
         /// A larger DPI would create a PDF that reflects the original intent with better fidelity, but it can make for larger PDF files too, which would use more memory while rendering, and it would be slower to be processed or sent online or to printer.
         /// When generating images, this parameter also controls the resolution of the generated content.
-        /// Default value is 72.
+        /// Default value is 144.
         /// </summary>
         public ImageDescriptor WithRasterDpi(int dpi)
         {
@@ -45,9 +45,9 @@ namespace QuestPDF.Fluent
 
         /// <summary>
         /// Encoding quality controls the trade-off between size and quality.
-        /// The value 101 corresponds to lossless encoding.
-        /// If this value is set to a value between 1 and 100, and the image is opaque, it will be encoded using the JPEG format with that quality setting.
-        /// The default value is 90 (very high quality).
+        /// When the image is opaque, it will be encoded using the JPEG format with the selected quality setting.
+        /// When the image contains an alpha channel, it is always encoded using the PNG format and this option is ignored.
+        /// The default value is "very high quality".
         /// </summary>
         public ImageDescriptor WithCompressionQuality(ImageCompressionQuality quality)
         {

+ 3 - 3
Source/QuestPDF/Infrastructure/DocumentSettings.cs

@@ -13,9 +13,9 @@
 
         /// <summary>
         /// Encoding quality controls the trade-off between size and quality.
-        /// The value 101 corresponds to lossless encoding.
-        /// If this value is set to a value between 1 and 100, and the image is opaque, it will be encoded using the JPEG format with that quality setting.
-        /// The default value is 90 (very high quality).
+        /// When the image is opaque, it will be encoded using the JPEG format with the selected quality setting.
+        /// When the image contains an alpha channel, it is always encoded using the PNG format and this option is ignored.
+        /// The default value is "very high quality".
         /// </summary>
         public ImageCompressionQuality ImageCompressionQuality { get; set; } = ImageCompressionQuality.VeryHigh;