Merge pull request #1981 from 0xced/fix-resolution-doc

Fix documentation of HorizontalResolution and VerticalResolution properties
SixLabors · Feb 8, 2022 · a844c78 · a844c78
2 parents 5d6f389 + 490bf0f
commit a844c78
Showing 1 changed file with 24 additions and 6 deletions.
diff --git a/src/ImageSharp/Metadata/ImageMetadata.cs b/src/ImageSharp/Metadata/ImageMetadata.cs
@@ -72,7 +72,7 @@ private ImageMetadata(ImageMetadata other)
 
         /// <summary>
         /// Gets or sets the resolution of the image in x- direction.
-        /// It is defined as the number of dots per inch and should be an positive value.
+        /// It is defined as the number of dots per <see cref="ResolutionUnits"/> and should be an positive value.
         /// </summary>
         /// <value>The density of the image in x- direction.</value>
         public double HorizontalResolution
@@ -90,7 +90,7 @@ public double HorizontalResolution
 
         /// <summary>
         /// Gets or sets the resolution of the image in y- direction.
-        /// It is defined as the number of dots per inch and should be an positive value.
+        /// It is defined as the number of dots per <see cref="ResolutionUnits"/> and should be an positive value.
         /// </summary>
         /// <value>The density of the image in y- direction.</value>
         public double VerticalResolution
@@ -108,10 +108,28 @@ public double VerticalResolution
 
         /// <summary>
         /// Gets or sets unit of measure used when reporting resolution.
-        ///  00 : No units; width:height pixel aspect ratio = Ydensity:Xdensity
-        ///  01 : Pixels per inch (2.54 cm)
-        ///  02 : Pixels per centimeter
-        ///  03 : Pixels per meter
+        /// <list type="table">
+        ///   <listheader>
+        ///     <term>Value</term>
+        ///     <description>Unit</description>
+        ///   </listheader>
+        ///   <item>
+        ///     <term>AspectRatio (00)</term>
+        ///     <description>No units; width:height pixel aspect ratio = Ydensity:Xdensity</description>
+        ///   </item>
+        ///   <item>
+        ///     <term>PixelsPerInch (01)</term>
+        ///     <description>Pixels per inch (2.54 cm)</description>
+        ///   </item>
+        ///   <item>
+        ///     <term>PixelsPerCentimeter (02)</term>
+        ///     <description>Pixels per centimeter</description>
+        ///   </item>
+        ///   <item>
+        ///     <term>PixelsPerMeter (03)</term>
+        ///     <description>Pixels per meter (100 cm)</description>
+        ///   </item>
+        /// </list>
         /// </summary>
         public PixelResolutionUnit ResolutionUnits { get; set; }