Fixing StyleCop warnings. No functional changes.

Author: jimevans

Knuckleball/Atom.cs

@@ -33,20 +33,30 @@ internal Atom()
         {
         }
 
+        /// <summary>
+        /// Gets the data type of the data stored in the atom.
+        /// </summary>
         internal virtual NativeMethods.MP4ItmfBasicType DataType 
         {
             get { return NativeMethods.MP4ItmfBasicType.Utf8; }
         }
 
+        /// <summary>
+        /// Gets the meaning of the atom.
+        /// </summary>
         internal abstract string Meaning { get; }
 
+        /// <summary>
+        /// Gets the name of the atom.
+        /// </summary>
         internal abstract string Name { get; }
 
         /// <summary>
         /// Initializes the <see cref="Atom"/> instance from the specified <see cref="IntPtr"/>
         /// value.
         /// </summary>
         /// <param name="fileHandle">The <see cref="IntPtr"/> file handle of the file from which to read this <see cref="Atom"/>.</param>
+        /// <returns><see langword="true"/> if this <see cref="Atom"/> was successfully initialized; otherwise, <see langword="false"/>.</returns>
         internal bool Initialize(IntPtr fileHandle)
         {
             bool isInitialized = false;
@@ -85,6 +95,10 @@ internal bool Initialize(IntPtr fileHandle)
         /// used to populate this <see cref="Atom"/>.</param>
         internal abstract void Populate(byte[] dataBuffer);
 
+        /// <summary>
+        /// Returns the data to be stored in this <see cref="Atom"/> as a byte array.
+        /// </summary>
+        /// <returns>The byte array containing the data to be stored in the atom.</returns>
         internal abstract byte[] ToByteArray();
     }
 }

Knuckleball/MP4File.cs

@@ -679,8 +679,8 @@ public void WriteTags()
                 NativeMethods.MP4TagsSetXID(tagsPtr, this.Xid);
             }
 
-            WriteTrackInfo(tagsPtr, tags.track);
-            WriteDiscInfo(tagsPtr, tags.disk);
+            this.WriteTrackInfo(tagsPtr, tags.track);
+            this.WriteDiscInfo(tagsPtr, tags.disk);
 
             // If the artwork has been edited, there are two possibilities:
             // First we are replacing an existing piece of artwork with another; or
@@ -689,7 +689,7 @@ public void WriteTags()
             {
                 if (this.artwork != null)
                 {
-                    WriteArtwork(tagsPtr);
+                    this.WriteArtwork(tagsPtr);
                 }
                 else if (this.ArtworkCount != 0)
                 {
@@ -706,11 +706,14 @@ public void WriteTags()
                 WriteRawAtom<RatingInfo>(fileHandle, this.RatingInfo);
             }
 
-            //MovieInfo movieInfo = ReadRawAtom<MovieInfo>(fileHandle);
-            //if (this.MovieInfo != movieInfo)
-            //{
-                WriteRawAtom<MovieInfo>(fileHandle, this.MovieInfo);
-            //}
+            // TODO: Implement an equality comparison for MovieInfo, so
+            // as to only write the atom to the file if it's been modified.
+            // MovieInfo movieInfo = ReadRawAtom<MovieInfo>(fileHandle);
+            // if (this.MovieInfo != movieInfo)
+            // {
+            //    WriteRawAtom<MovieInfo>(fileHandle, this.MovieInfo);
+            // }
+            WriteRawAtom<MovieInfo>(fileHandle, this.MovieInfo);
 
             NativeMethods.MP4Close(fileHandle);
         }
@@ -821,7 +824,7 @@ private void ReadArtwork(IntPtr artworkStructurePointer)
             byte[] artworkBuffer = new byte[artwork.size];
             Marshal.Copy(artwork.data, artworkBuffer, 0, artwork.size);
             this.artworkStream = new MemoryStream(artworkBuffer);
-            this.artwork = Image.FromStream(artworkStream);
+            this.artwork = Image.FromStream(this.artworkStream);
 
             switch (artwork.type)
             {

Knuckleball/MP4TagsStructureExtensions.cs

@@ -16,8 +16,8 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
 using System.Runtime.InteropServices;
+using System.Text;
 
 namespace Knuckleball
 {

Knuckleball/MovieInfo.cs

@@ -104,7 +104,7 @@ public IList<string> Directors
         }
 
         /// <summary>
-        /// Gets or sets a list of producers for this movie.
+        /// Gets a list of producers for this movie.
         /// </summary>
         /// <remarks>
         /// The <see cref="Producers"/> property is read-only, but can be
@@ -132,7 +132,7 @@ public IList<string> Producers
         }
 
         /// <summary>
-        /// Gets or sets a list of screenwriters for this movie.
+        /// Gets a list of screenwriters for this movie.
         /// </summary>
         /// <remarks>
         /// The <see cref="Screenwriters"/> property is read-only, but can be
@@ -159,61 +159,95 @@ public IList<string> Screenwriters
             }
         }
 
-
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="Cast"/> property has data, potentially including an empty list.
+        /// Returns <see langword="false"/> if the <see cref="Cast"/> property is <see langword="null"/>.
+        /// </summary>
         public bool HasCast
         {
             get { return this.cast != null; }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="Directors"/> property has data, potentially including an empty list.
+        /// Returns <see langword="false"/> if the <see cref="Directors"/> property is <see langword="null"/>.
+        /// </summary>
         public bool HasDirectors
         {
             get { return this.directors != null; }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="Producers"/> property has data, potentially including an empty list.
+        /// Returns <see langword="false"/> if the <see cref="Producers"/> property is <see langword="null"/>.
+        /// </summary>
         public bool HasProducers
         {
             get { return this.producers != null; }
         }
 
+        /// <summary>
+        /// Gets a value indicating whether the <see cref="Screenwriters"/> property has data, potentially including an empty list.
+        /// Returns <see langword="false"/> if the <see cref="Screenwriters"/> property is <see langword="null"/>.
+        /// </summary>
         public bool HasScreenwriters
         {
             get { return this.screenwriters != null; }
         }
 
+        /// <summary>
+        /// Gets the meaning of the atom.
+        /// </summary>
         internal override string Meaning
         {
             get { return "com.apple.iTunes"; }
         }
 
+        /// <summary>
+        /// Gets the name of the atom.
+        /// </summary>
         internal override string Name
         {
             get { return "iTunMOVI"; }
         }
 
+        /// <summary>
+        /// Removes all data from the <see cref="Cast"/> property, causing it to be <see langword="null"/>.
+        /// </summary>
         public void RemoveCast()
         {
             this.cast = null;
         }
 
+        /// <summary>
+        /// Removes all data from the <see cref="Directors"/> property, causing it to be <see langword="null"/>.
+        /// </summary>
         public void RemoveDirectors()
         {
             this.directors = null;
         }
 
+        /// <summary>
+        /// Removes all data from the <see cref="Producers"/> property, causing it to be <see langword="null"/>.
+        /// </summary>
         public void RemoveProducers()
         {
             this.producers = null;
         }
 
+        /// <summary>
+        /// Removes all data from the <see cref="Screenwriters"/> property, causing it to be <see langword="null"/>.
+        /// </summary>
         public void RemoveScreenwriters()
         {
             this.screenwriters = null;
         }
 
         /// <summary>
-        /// Populates this <see cref="MovieInfo"/> with the specific data stored in it in the referenced file.
+        /// Populates this <see cref="MovieInfo"/> with the specific data stored in it.
         /// </summary>
-        /// <param name="data">The iTunes Metadata Format data used to populate this <see cref="MovieInfo"/>.</param>
+        /// <param name="dataBuffer">A byte array containing the iTunes Metadata Format data
+        /// used to populate this <see cref="MovieInfo"/>.</param>
         internal override void Populate(byte[] dataBuffer)
         {
             Dictionary<string, object> map = null;
@@ -252,6 +286,10 @@ internal override void Populate(byte[] dataBuffer)
             }
         }
 
+        /// <summary>
+        /// Returns the data to be stored in this <see cref="MovieInfo"/> as a byte array.
+        /// </summary>
+        /// <returns>The byte array containing the data to be stored in the atom.</returns>
         internal override byte[] ToByteArray()
         {
             byte[] buffer = null;
@@ -314,7 +352,7 @@ internal override byte[] ToByteArray()
             return buffer;
         }
 
-        private void WriteList(XmlWriter writer, IList<string> list, string listName)
+        private static void WriteList(XmlWriter writer, IList<string> list, string listName)
         {
             writer.WriteElementString("key", listName);
             writer.WriteStartElement("array");