Skip to content

Fix documentation of HorizontalResolution and VerticalResolution properties #1981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 8, 2022
Merged

Fix documentation of HorizontalResolution and VerticalResolution properties #1981

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions src/ImageSharp/Metadata/ImageMetadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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; }

Expand Down