2007-05-25 Brian Nickel <brian.nickel@gmail.com>

There were changes to 153 files in the last three days. I can't vouch for
everything that happened, as I may have blacked out for some portions, but tags
now have an abstract Tag.TagTypes property, Everything that should be a struct
is, there were a bunch of tiny cleanups, "private Flac.File+PictureTag" is now
"public Flac.Metadata"... And as of 3:55 AM (Arizona Time), THERE IS NOT ONE 
FREAKIN' INSTANCE OF "To be added." IN THE ENTIRE docs/en DIRECTORY. I really 
must love you guys, 'cause that was really, really painful.

	* src/TagLib/Tag.cs:
	* src/TagLib/CombinedTag.cs:
	* src/TagLib/File.cs:
	* src/TagLib/Id3v1/Tag.cs:
	* src/TagLib/Riff/AviStream.cs:
	* src/TagLib/Riff/File.cs:
	* src/TagLib/Riff/DivXTag.cs:
	* src/TagLib/Riff/InfoTag.cs:
	* src/TagLib/Riff/MovieIdTag.cs:
	* src/TagLib/Id3v2/Tag.cs:
	* src/TagLib/Id3v2/Frames/PlayCountFrame.cs:
	* src/TagLib/Id3v2/ExtendedHeader.cs:
	* src/TagLib/Mpeg/XingHeader.cs:
	* src/TagLib/Mpeg/File.cs:
	* src/TagLib/Mpeg/AudioFile.cs:
	* src/TagLib/Mpeg/AudioHeader.cs:
	* src/TagLib/NonContainer/Tag.cs:
	* src/TagLib/NonContainer/File.cs:
	* src/TagLib/NonContainer/EndTag.cs:
	* src/TagLib/NonContainer/StartTag.cs:
	* src/TagLib/Ape/Tag.cs:
	* src/TagLib/Flac/Picture.cs:
	* src/TagLib/Flac/File.cs:
	* src/TagLib/Flac/StreamHeader.cs:
	* src/TagLib/Asf/Tag.cs:
	* src/TagLib/Asf/File.cs:
	* src/TagLib/Mpeg4/Boxes/FullBox.cs:
	* src/TagLib/Mpeg4/Boxes/IsoMovieHeaderBox.cs:
	* src/TagLib/Mpeg4/Boxes/IsoSampleEntry.cs:
	* src/TagLib/Mpeg4/Boxes/IsoChunkLargeOffsetBox.cs:
	* src/TagLib/Mpeg4/Boxes/IsoAudioSampleEntry.cs:
	* src/TagLib/Mpeg4/Boxes/IsoHandlerBox.cs:
	* src/TagLib/Mpeg4/Boxes/IsoVisualSampleEntry.cs:
	* src/TagLib/Mpeg4/Boxes/IsoChunkOffsetBox.cs:
	* src/TagLib/Mpeg4/Boxes/AppleDataBox.cs:
	* src/TagLib/Mpeg4/Boxes/IsoSampleDescriptionBox.cs:
	* src/TagLib/Mpeg4/FileParser.cs:
	* src/TagLib/Mpeg4/AppleTag.cs:
	* src/TagLib/Mpeg4/File.cs:
	* src/TagLib/Mpeg4/BoxFactory.cs:
	* src/TagLib/Mpeg4/BoxHeader.cs:
	* src/TagLib/Mpeg4/BoxList.cs:
	* src/TagLib/Mpeg4/Box.cs:
	* src/TagLib/Ogg/XiphComment.cs:
	* src/TagLib/Ogg/Page.cs:
	* src/TagLib/Ogg/Codecs/Theora.cs:
	* src/TagLib/Ogg/Codecs/Vorbis.cs:
	* src/TagLib/Ogg/Codec.cs:
	* src/TagLib/Ogg/File.cs:
	* src/TagLib/Ogg/Paginator.cs:
	* src/TagLib/Ogg/GroupedComment.cs:
	* src/TagLib/Ogg/Bitstream.cs:
	* src/taglib-sharp.mdp: 53 C# files changed.
	* docs/en/*: 100 XML files filled in.

svn path=/trunk/taglib-sharp/; revision=77938

ChangeLog

@@ -1,3 +1,68 @@
+2007-05-25  Brian Nickel <brian.nickel@gmail.com>
+
+There were changes to 153 files in the last three days. I can't vouch for
+everything that happened, as I may have blacked out for some portions, but tags
+now have an abstract Tag.TagTypes property, Everything that should be a struct
+is, there were a bunch of tiny cleanups, "private Flac.File+PictureTag" is now
+"public Flac.Metadata"... And as of 3:55 AM (Arizona Time), THERE IS NOT ONE 
+FREAKIN' INSTANCE OF "To be added." IN THE ENTIRE docs/en DIRECTORY. I really 
+must love you guys, 'cause that was really, really painful.
+
+	* src/TagLib/Tag.cs:
+	* src/TagLib/CombinedTag.cs:
+	* src/TagLib/File.cs:
+	* src/TagLib/Id3v1/Tag.cs:
+	* src/TagLib/Riff/AviStream.cs:
+	* src/TagLib/Riff/File.cs:
+	* src/TagLib/Riff/DivXTag.cs:
+	* src/TagLib/Riff/InfoTag.cs:
+	* src/TagLib/Riff/MovieIdTag.cs:
+	* src/TagLib/Id3v2/Tag.cs:
+	* src/TagLib/Id3v2/Frames/PlayCountFrame.cs:
+	* src/TagLib/Id3v2/ExtendedHeader.cs:
+	* src/TagLib/Mpeg/XingHeader.cs:
+	* src/TagLib/Mpeg/File.cs:
+	* src/TagLib/Mpeg/AudioFile.cs:
+	* src/TagLib/Mpeg/AudioHeader.cs:
+	* src/TagLib/NonContainer/Tag.cs:
+	* src/TagLib/NonContainer/File.cs:
+	* src/TagLib/NonContainer/EndTag.cs:
+	* src/TagLib/NonContainer/StartTag.cs:
+	* src/TagLib/Ape/Tag.cs:
+	* src/TagLib/Flac/Picture.cs:
+	* src/TagLib/Flac/File.cs:
+	* src/TagLib/Flac/StreamHeader.cs:
+	* src/TagLib/Asf/Tag.cs:
+	* src/TagLib/Asf/File.cs:
+	* src/TagLib/Mpeg4/Boxes/FullBox.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoMovieHeaderBox.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoSampleEntry.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoChunkLargeOffsetBox.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoAudioSampleEntry.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoHandlerBox.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoVisualSampleEntry.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoChunkOffsetBox.cs:
+	* src/TagLib/Mpeg4/Boxes/AppleDataBox.cs:
+	* src/TagLib/Mpeg4/Boxes/IsoSampleDescriptionBox.cs:
+	* src/TagLib/Mpeg4/FileParser.cs:
+	* src/TagLib/Mpeg4/AppleTag.cs:
+	* src/TagLib/Mpeg4/File.cs:
+	* src/TagLib/Mpeg4/BoxFactory.cs:
+	* src/TagLib/Mpeg4/BoxHeader.cs:
+	* src/TagLib/Mpeg4/BoxList.cs:
+	* src/TagLib/Mpeg4/Box.cs:
+	* src/TagLib/Ogg/XiphComment.cs:
+	* src/TagLib/Ogg/Page.cs:
+	* src/TagLib/Ogg/Codecs/Theora.cs:
+	* src/TagLib/Ogg/Codecs/Vorbis.cs:
+	* src/TagLib/Ogg/Codec.cs:
+	* src/TagLib/Ogg/File.cs:
+	* src/TagLib/Ogg/Paginator.cs:
+	* src/TagLib/Ogg/GroupedComment.cs:
+	* src/TagLib/Ogg/Bitstream.cs:
+	* src/taglib-sharp.mdp: 53 C# files changed.
+	* docs/en/*: 100 XML files filled in.
+
 2007-05-22  Brian Nickel <brian.nickel@gmail.com>
 
 	* src/TagLib/Tag.cs: Make abstract.

configure.ac

@@ -33,7 +33,7 @@ if test x$MONO = x; then
 	AC_MSG_ERROR(You need mono)
 fi
 
-MCS_FLAGS="-codepage:utf8 -r:Mono.Posix -debug"
+MCS_FLAGS="-codepage:utf8 -debug"
 MONO_FLAGS=
 
 if test $USE_MAINTAINER_MODE = yes; then

docs/en/TagLib.Ape.xml

@@ -1,6 +1,6 @@
 <Namespace Name="TagLib.Ape">
   <Docs>
-    <summary><para>The TagLib.Ape namespace contains all classes relevant to the reading APE tags.</para></summary>
+    <summary><para>The TagLib.Ape namespace contains classes for handling the reading APE tags.</para></summary>
     <remarks><para>See http://wiki.hydrogenaudio.org/index.php?title=APEv2 for the complete specification.</para></remarks>
   </Docs>
 </Namespace>

docs/en/TagLib.Ape/Footer.xml

@@ -125,9 +125,9 @@
         <ReturnType>TagLib.Ape.FooterFlags</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets and sets the flags for the current instance.</summary>
+        <value>A <see cref="T:TagLib.Ape.Footer" /> containing the flags.</value>
+        <remarks />
       </Docs>
     </Member>
   </Members>

docs/en/TagLib.Ape/FooterFlags.xml

@@ -0,0 +1,46 @@
+<Type Name="FooterFlags" FullName="TagLib.Ape.FooterFlags">
+  <TypeSignature Language="C#" Value="public enum FooterFlags" />
+  <AssemblyInfo>
+    <AssemblyName>taglib-sharp</AssemblyName>
+    <AssemblyVersion>1.9.0.0</AssemblyVersion>
+  </AssemblyInfo>
+  <Base>
+    <BaseTypeName>System.Enum</BaseTypeName>
+  </Base>
+  <Members>
+    <Member MemberName="FooterAbsent">
+      <MemberSignature Language="C#" Value="FooterAbsent" />
+      <MemberType>Field</MemberType>
+      <ReturnValue>
+        <ReturnType>TagLib.Ape.FooterFlags</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>The tag excludes a footer.</summary>
+      </Docs>
+    </Member>
+    <Member MemberName="HeaderPresent">
+      <MemberSignature Language="C#" Value="HeaderPresent" />
+      <MemberType>Field</MemberType>
+      <ReturnValue>
+        <ReturnType>TagLib.Ape.FooterFlags</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>The tag includes a header.</summary>
+      </Docs>
+    </Member>
+    <Member MemberName="IsHeader">
+      <MemberSignature Language="C#" Value="IsHeader" />
+      <MemberType>Field</MemberType>
+      <ReturnValue>
+        <ReturnType>TagLib.Ape.FooterFlags</ReturnType>
+      </ReturnValue>
+      <Docs>
+        <summary>The footer is a header.</summary>
+      </Docs>
+    </Member>
+  </Members>
+  <Docs>
+    <summary>Specified what flags are applied to an APE version 2 footer.</summary>
+    <remarks />
+  </Docs>
+</Type>

docs/en/TagLib.Ape/Tag.xml

@@ -15,11 +15,7 @@
       <Parameters />
       <Docs>
         <summary>Constructs and initializes a new instance of <see cref="T:TagLib.Ape.Tag" /> with no content.</summary>
-        <remarks>
-          <para>
-To access or create an <see cref="T:TagLib.Ape.Tag" /> in an existing <see cref="T:TagLib.File" />, use <see cref="M:TagLib.File.GetTag(TagLib.TagTypes,bool)" />.
-</para>
-        </remarks>
+        <remarks>To access or create an <see cref="T:TagLib.Ape.Tag" /> in an existing <see cref="T:TagLib.File" />, use <see cref="M:TagLib.File.GetTag(TagLib.TagTypes,bool)" />.</remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -31,8 +27,7 @@ To access or create an <see cref="T:TagLib.Ape.Tag" /> in an existing <see cref=
       </Parameters>
       <Docs>
         <param name="file">A <see cref="T:TagLib.File" /> containing a tag to read.</param>
-        <param name="offset">A <see cref="T:System.Int64" /> specifying where to read from the file. It must be the position of either an APE header or footer.
-</param>
+        <param name="offset">A <see cref="T:System.Int64" /> specifying where to read from the file. It must be the position of either an APE header or footer.</param>
         <summary>Constructs and initializes a new instance of <see cref="T:TagLib.Ape.Tag" /> by reading from a <see cref="T:TagLib.File" /> at a specified position.</summary>
         <remarks>
           <para>
@@ -112,9 +107,7 @@ To access or create an <see cref="T:TagLib.Ape.Tag" /> in an existing <see cref=
         <param name="number">A <see cref="T:System.UInt32" />.</param>
         <param name="count">A <see cref="T:System.UInt32" /> representing a total which <paramref name="number" /> is a part of, or zero if <paramref name="number" /> is not part of a set.</param>
         <summary>Sets a numeric value in an ape item.</summary>
-        <remarks>If both <paramref name="number" /> and <paramref name="count" /> are equal to zero, the value will be cleared. If <paramref name="count" /> is zero, <paramref name="number" /> by itself will be stored.
-
-Otherwise, the values will be stored as "<paramref name="number" />/<paramref name="count" />".</remarks>
+        <remarks>If both <paramref name="number" /> and <paramref name="count" /> are equal to zero, the value will be cleared. If <paramref name="count" /> is zero, <paramref name="number" /> by itself will be stored. Otherwise, the values will be stored as "<paramref name="number" />/<paramref name="count" />".</remarks>
       </Docs>
     </Member>
     <Member MemberName="AddValue">
@@ -260,9 +253,9 @@ Otherwise, the values will be added as "<paramref name="number" />/<paramref nam
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets and sets whether or not the tag will be rendered with a header.</summary>
+        <value>A <see cref="T:System.Boolean" /> specifying whether or not a header will be rendered.</value>
+        <remarks />
       </Docs>
     </Member>
   </Members>

docs/en/TagLib.Asf.xml

@@ -1,6 +1,6 @@
 <Namespace Name="TagLib.Asf">
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>The TagLib.Asf namespace contains classes for handling the Microsoft Advanced Systems Format file format.</summary>
+    <remarks>See http://www.microsoft.com/windows/windowsmedia/forpros/format/asfspec.aspx for the complete specification.</remarks>
   </Docs>
 </Namespace>

docs/en/TagLib.Asf/HeaderObject.xml

@@ -97,9 +97,10 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets whether or not the current instance has content descriptors.</summary>
+        <value>
+          <see langword="true" /> if it does. Otherwise <see langword="false" />.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="RemoveContentDescriptors">
@@ -110,8 +111,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Removes the content descriptors contained in the current instance.</summary>
+        <remarks />
       </Docs>
     </Member>
   </Members>

docs/en/TagLib.Flac.xml

@@ -1,6 +1,6 @@
 <Namespace Name="TagLib.Flac">
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>The TagLib.Flac namespace contains classes for handling the Xiph FLAC file format.</summary>
+    <remarks>See http://flac.sourceforge.net/format.html for the complete specification.</remarks>
   </Docs>
 </Namespace>

docs/en/TagLib.Flac/Block.xml

@@ -18,11 +18,11 @@
         <Parameter Name="position" Type="System.Int64" />
       </Parameters>
       <Docs>
-        <param name="header">To be added.</param>
-        <param name="data">To be added.</param>
-        <param name="position">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="header">A <see cref="T:TagLib.Flac.BlockHeader" /> for the new instance.</param>
+        <param name="data">A <see cref="T:TagLib.ByteVector" /> containing the block's contents.</param>
+        <param name="position">A <see cref="T:System.Int64" /> specifying the seek position of the block in the file.</param>
+        <summary>Constructs and initializes a new instance of <see cref="T:TagLib.Flac.Block" /> with a specified header, contents, and file position.</summary>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -33,10 +33,10 @@
         <Parameter Name="data" Type="TagLib.ByteVector" />
       </Parameters>
       <Docs>
-        <param name="type">To be added.</param>
-        <param name="data">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="type">A <see cref="T:TagLib.Flac.BlockType" /> specifying the type of the new instance.</param>
+        <param name="data">A <see cref="T:TagLib.ByteVector" /> containing the block's contents.</param>
+        <summary>Constructs and initializes a new instance of <see cref="T:TagLib.Flac.Block" /> with a specified type and contents.</summary>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Render">
@@ -49,10 +49,10 @@
         <Parameter Name="is_last_block" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="is_last_block">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="is_last_block">A <see cref="T:System.Boolean" /> specifying whether or not the block is the last metadata block.</param>
+        <summary>Renders the current instance as a FLAC metadata block.</summary>
+        <returns>A <see cref="T:TagLib.ByteVector" /> containing the rendered version.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Type">
@@ -62,9 +62,9 @@
         <ReturnType>TagLib.Flac.BlockType</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the type of the current instance.</summary>
+        <value>A <see cref="T:TagLib.Flac.BlockType" /> containing the type.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="IsLastBlock">
@@ -74,9 +74,9 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets whether or not the current instance is the last metadata block.</summary>
+        <value>A <see cref="T:System.Boolean" /> specifying whether or not the block is the last metadata block.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Length">
@@ -86,9 +86,9 @@
         <ReturnType>System.UInt32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the length of the data in the current instance.</summary>
+        <value>A <see cref="T:System.UInt32" /> containing the length.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="TotalLength">
@@ -98,9 +98,9 @@
         <ReturnType>System.UInt32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the length of the rendered version of the current instance.</summary>
+        <value>A <see cref="T:System.UInt32" /> containing the length.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Data">
@@ -110,9 +110,9 @@
         <ReturnType>TagLib.ByteVector</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the data contained in the current instance.</summary>
+        <value>A <see cref="T:System.UInt32" /> containing the data.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Position">
@@ -122,9 +122,9 @@
         <ReturnType>System.Int64</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the position at which the current instance appears in the file.</summary>
+        <value>A <see cref="T:System.UInt32" /> containing the position.</value>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="NextBlockPosition">
@@ -134,14 +134,14 @@
         <ReturnType>System.Int64</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the position of the next block in the file.</summary>
+        <value>A <see cref="T:System.UInt32" /> containing the position.</value>
+        <remarks />
       </Docs>
     </Member>
   </Members>
   <Docs>
-    <summary>To be added.</summary>
-    <remarks>To be added.</remarks>
+    <summary>This class is used to read and create FLAC metadata blocks.</summary>
+    <remarks />
   </Docs>
 </Type>

docs/en/TagLib.Flac/BlockHeader.xml

@@ -101,7 +101,7 @@
     </Member>
   </Members>
   <Docs>
-    <summary>This class is used to access FLAC block headers.</summary>
+    <summary>This struct is used to access FLAC block headers.</summary>
     <remarks />
   </Docs>
 </Type>