Skip to content

Commit a844c78

Browse files
Merge pull request #1981 from 0xced/fix-resolution-doc
Fix documentation of HorizontalResolution and VerticalResolution properties
2 parents 5d6f389 + 490bf0f commit a844c78

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

src/ImageSharp/Metadata/ImageMetadata.cs

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ private ImageMetadata(ImageMetadata other)
7272

7373
/// <summary>
7474
/// Gets or sets the resolution of the image in x- direction.
75-
/// It is defined as the number of dots per inch and should be an positive value.
75+
/// It is defined as the number of dots per <see cref="ResolutionUnits"/> and should be an positive value.
7676
/// </summary>
7777
/// <value>The density of the image in x- direction.</value>
7878
public double HorizontalResolution
@@ -90,7 +90,7 @@ public double HorizontalResolution
9090

9191
/// <summary>
9292
/// Gets or sets the resolution of the image in y- direction.
93-
/// It is defined as the number of dots per inch and should be an positive value.
93+
/// It is defined as the number of dots per <see cref="ResolutionUnits"/> and should be an positive value.
9494
/// </summary>
9595
/// <value>The density of the image in y- direction.</value>
9696
public double VerticalResolution
@@ -108,10 +108,28 @@ public double VerticalResolution
108108

109109
/// <summary>
110110
/// Gets or sets unit of measure used when reporting resolution.
111-
/// 00 : No units; width:height pixel aspect ratio = Ydensity:Xdensity
112-
/// 01 : Pixels per inch (2.54 cm)
113-
/// 02 : Pixels per centimeter
114-
/// 03 : Pixels per meter
111+
/// <list type="table">
112+
/// <listheader>
113+
/// <term>Value</term>
114+
/// <description>Unit</description>
115+
/// </listheader>
116+
/// <item>
117+
/// <term>AspectRatio (00)</term>
118+
/// <description>No units; width:height pixel aspect ratio = Ydensity:Xdensity</description>
119+
/// </item>
120+
/// <item>
121+
/// <term>PixelsPerInch (01)</term>
122+
/// <description>Pixels per inch (2.54 cm)</description>
123+
/// </item>
124+
/// <item>
125+
/// <term>PixelsPerCentimeter (02)</term>
126+
/// <description>Pixels per centimeter</description>
127+
/// </item>
128+
/// <item>
129+
/// <term>PixelsPerMeter (03)</term>
130+
/// <description>Pixels per meter (100 cm)</description>
131+
/// </item>
132+
/// </list>
115133
/// </summary>
116134
public PixelResolutionUnit ResolutionUnits { get; set; }
117135

0 commit comments

Comments
 (0)