Merge remote-tracking branch 'TsudaKageyu/comment-update'

taglib/asf/asffile.h

@@ -51,7 +51,8 @@ namespace TagLib {
        * Constructs an ASF file from \a file.
        *
        * \note In the current implementation, both \a readProperties and
-       * \a propertiesStyle are ignored.
+       * \a propertiesStyle are ignored.  The audio properties are always
+       * read.
        */
       File(FileName file, bool readProperties = true, 
            Properties::ReadStyle propertiesStyle = Properties::Average);
@@ -60,7 +61,8 @@ namespace TagLib {
        * Constructs an ASF file from \a stream.
        *
        * \note In the current implementation, both \a readProperties and
-       * \a propertiesStyle are ignored.
+       * \a propertiesStyle are ignored.  The audio properties are always
+       * read.
        *
        * \note TagLib will *not* take ownership of the stream, the caller is
        * responsible for deleting it after the File object.

taglib/it/itfile.h

@@ -39,7 +39,8 @@ namespace TagLib {
          * Constructs a Impulse Tracker file from \a file.
          *
          * \note In the current implementation, both \a readProperties and
-         * \a propertiesStyle are ignored.
+         * \a propertiesStyle are ignored.  The audio properties are always
+         * read.
          */
         File(FileName file, bool readProperties = true,
              AudioProperties::ReadStyle propertiesStyle =
@@ -49,7 +50,8 @@ namespace TagLib {
          * Constructs a Impulse Tracker file from \a stream.
          *
          * \note In the current implementation, both \a readProperties and
-         * \a propertiesStyle are ignored.
+         * \a propertiesStyle are ignored.  The audio properties are always
+         * read.
          *
          * \note TagLib will *not* take ownership of the stream, the caller is
          * responsible for deleting it after the File object.

taglib/mod/modfile.h

@@ -40,7 +40,8 @@ namespace TagLib {
        * Constructs a Protracker file from \a file.
        *
        * \note In the current implementation, both \a readProperties and
-       * \a propertiesStyle are ignored.
+       * \a propertiesStyle are ignored.  The audio properties are always
+       * read.
        */
       File(FileName file, bool readProperties = true,
            AudioProperties::ReadStyle propertiesStyle =
@@ -50,7 +51,8 @@ namespace TagLib {
        * Constructs a Protracker file from \a stream.
        *
        * \note In the current implementation, both \a readProperties and
-       * \a propertiesStyle are ignored.
+       * \a propertiesStyle are ignored.  The audio properties are always
+       * read.
        *
        * \note TagLib will *not* take ownership of the stream, the caller is
        * responsible for deleting it after the File object.

taglib/ogg/oggfile.h

@@ -82,9 +82,7 @@ namespace TagLib {
 
     protected:
       /*!
-       * Contructs an Ogg file from \a file.  If \a readProperties is true the
-       * file's audio properties will also be read using \a propertiesStyle.  If
-       * false, \a propertiesStyle is ignored.
+       * Constructs an Ogg file from \a file.
        *
        * \note This constructor is protected since Ogg::File shouldn't be
        * instantiated directly but rather should be used through the codec
@@ -93,9 +91,7 @@ namespace TagLib {
       File(FileName file);
 
       /*!
-       * Contructs an Ogg file from \a file.  If \a readProperties is true the
-       * file's audio properties will also be read using \a propertiesStyle.  If
-       * false, \a propertiesStyle is ignored.
+       * Constructs an Ogg file from \a stream.
        *
        * \note This constructor is protected since Ogg::File shouldn't be
        * instantiated directly but rather should be used through the codec

taglib/s3m/s3mfile.h

@@ -39,7 +39,8 @@ namespace TagLib {
          * Constructs a ScreamTracker III from \a file.
          *
          * \note In the current implementation, both \a readProperties and
-         * \a propertiesStyle are ignored.
+         * \a propertiesStyle are ignored.  The audio properties are always
+         * read.
          */
         File(FileName file, bool readProperties = true,
              AudioProperties::ReadStyle propertiesStyle =
@@ -49,7 +50,8 @@ namespace TagLib {
          * Constructs a ScreamTracker III file from \a stream.
          *
          * \note In the current implementation, both \a readProperties and
-         * \a propertiesStyle are ignored.
+         * \a propertiesStyle are ignored.  The audio properties are always
+         * read.
          *
          * \note TagLib will *not* take ownership of the stream, the caller is
          * responsible for deleting it after the File object.

taglib/toolkit/tbytevector.h

@@ -64,17 +64,17 @@ namespace TagLib {
     ByteVector(uint size, char value = 0);
 
     /*!
-     * Contructs a byte vector that is a copy of \a v.
+     * Constructs a byte vector that is a copy of \a v.
      */
     ByteVector(const ByteVector &v);
 
     /*!
-     * Contructs a byte vector that is a copy of \a v.
+     * Constructs a byte vector that is a copy of \a v.
      */
     ByteVector(const ByteVector &v, uint offset, uint length);
 
     /*!
-     * Contructs a byte vector that contains \a c.
+     * Constructs a byte vector that contains \a c.
      */
     ByteVector(char c);
 

taglib/wavpack/wavpackfile.h

@@ -84,7 +84,6 @@ namespace TagLib {
        * file's audio properties will also be read using \a propertiesStyle.  If
        * false, \a propertiesStyle is ignored
        */
-
       File(FileName file, bool readProperties = true,
            Properties::ReadStyle propertiesStyle = Properties::Average);
 

taglib/xm/xmfile.h

@@ -39,7 +39,8 @@ namespace TagLib {
          * Constructs an Extended Module file from \a file.
          *
          * \note In the current implementation, both \a readProperties and
-         * \a propertiesStyle are ignored.
+         * \a propertiesStyle are ignored.  The audio properties are always
+         * read.
          */
         File(FileName file, bool readProperties = true,
              AudioProperties::ReadStyle propertiesStyle =
@@ -49,7 +50,8 @@ namespace TagLib {
          * Constructs an Extended Module file from \a stream.
          *
          * \note In the current implementation, both \a readProperties and
-         * \a propertiesStyle are ignored.
+         * \a propertiesStyle are ignored.  The audio properties are always
+         * read.
          *
          * \note TagLib will *not* take ownership of the stream, the caller is
          * responsible for deleting it after the File object.