From dfb702f5bf5df4c1000e96d1c7407bcaf3c09827 Mon Sep 17 00:00:00 2001 From: James Jackson-South Date: Mon, 5 Dec 2016 23:57:53 +1100 Subject: [PATCH] Clean up some EXIF documentation --- src/ImageSharp/Profiles/Exif/ExifProfile.cs | 9 +++++++ .../Exif/ExifTagDescriptionAttribute.cs | 10 +++++++- src/ImageSharp/Profiles/Exif/ExifWriter.cs | 24 ++++++++++++++++--- 3 files changed, 39 insertions(+), 4 deletions(-) diff --git a/src/ImageSharp/Profiles/Exif/ExifProfile.cs b/src/ImageSharp/Profiles/Exif/ExifProfile.cs index 7694ef7c6..2b7cb55a4 100644 --- a/src/ImageSharp/Profiles/Exif/ExifProfile.cs +++ b/src/ImageSharp/Profiles/Exif/ExifProfile.cs @@ -117,6 +117,9 @@ namespace ImageSharp /// /// The pixel format. /// The packed format. uint, long, float. + /// + /// The . + /// public Image CreateThumbnail() where TColor : struct, IPackedPixel where TPacked : struct @@ -143,6 +146,9 @@ namespace ImageSharp /// Returns the value with the specified tag. /// /// The tag of the EXIF value. + /// + /// The . + /// public ExifValue GetValue(ExifTag tag) { foreach (ExifValue exifValue in this.Values) @@ -160,6 +166,9 @@ namespace ImageSharp /// Removes the value with the specified tag. /// /// The tag of the EXIF value. + /// + /// The . + /// public bool RemoveValue(ExifTag tag) { this.InitializeValues(); diff --git a/src/ImageSharp/Profiles/Exif/ExifTagDescriptionAttribute.cs b/src/ImageSharp/Profiles/Exif/ExifTagDescriptionAttribute.cs index ca19a9776..e08bddd3f 100644 --- a/src/ImageSharp/Profiles/Exif/ExifTagDescriptionAttribute.cs +++ b/src/ImageSharp/Profiles/Exif/ExifTagDescriptionAttribute.cs @@ -28,6 +28,14 @@ namespace ImageSharp this.description = description; } + /// + /// Gets the tag description from any custom attributes. + /// + /// The tag. + /// The value. + /// + /// The . + /// public static string GetDescription(ExifTag tag, object value) { FieldInfo field = tag.GetType().GetTypeInfo().GetDeclaredField(tag.ToString()); @@ -40,7 +48,7 @@ namespace ImageSharp { object attributeValue = customAttribute.ConstructorArguments[0].Value; - if (Equals(attributeValue, value)) + if (object.Equals(attributeValue, value)) { return (string)customAttribute.ConstructorArguments[1].Value; } diff --git a/src/ImageSharp/Profiles/Exif/ExifWriter.cs b/src/ImageSharp/Profiles/Exif/ExifWriter.cs index daf0d9f2f..bf8f4caa2 100644 --- a/src/ImageSharp/Profiles/Exif/ExifWriter.cs +++ b/src/ImageSharp/Profiles/Exif/ExifWriter.cs @@ -10,11 +10,20 @@ namespace ImageSharp using System.Collections.ObjectModel; using System.Text; + /// + /// Contains methods for writing EXIF metadata. + /// internal sealed class ExifWriter { + /// + /// The start index. + /// private const int StartIndex = 6; - private static readonly ExifTag[] IfdTags = new ExifTag[127] + /// + /// The collection if Image File Directory tags + /// + private static readonly ExifTag[] IfdTags = { ExifTag.SubfileType, ExifTag.OldSubfileType, @@ -145,7 +154,10 @@ namespace ImageSharp ExifTag.GDALNoData }; - private static readonly ExifTag[] ExifTags = new ExifTag[92] + /// + /// The collection of Exif tags + /// + private static readonly ExifTag[] ExifTags = { ExifTag.ExposureTime, ExifTag.FNumber, @@ -241,7 +253,10 @@ namespace ImageSharp ExifTag.LensSerialNumber }; - private static readonly ExifTag[] GPSTags = new ExifTag[31] + /// + /// The collection of GPS tags + /// + private static readonly ExifTag[] GPSTags = { ExifTag.GPSVersionID, ExifTag.GPSLatitudeRef, @@ -276,6 +291,9 @@ namespace ImageSharp ExifTag.GPSDifferential }; + /// + /// Which parts will be written. + /// private ExifParts allowedParts; private Collection values; private Collection dataOffsets;