Comment update: Added some supplementary explanations and fixed some spellings.

diff --git a/taglib/asf/asffile.h b/taglib/asf/asffile.h
index 4e850d6da8b8e45cd1f81ccf63ddaed136293a88..f43b54f4c0c4a97158ec8f21e23da1eae8c8d52d 100644 (file)
--- a/taglib/asf/asffile.h
+++ b/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.

diff --git a/taglib/it/itfile.h b/taglib/it/itfile.h
index abbdfd3beb997e54c6400edac16d324691ccc7fd..19327dc65e0df787abaf87904b6402dafaa18bf3 100644 (file)
--- a/taglib/it/itfile.h
+++ b/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.

diff --git a/taglib/mod/modfile.h b/taglib/mod/modfile.h
index 6113f9feb5f906103821e1f93f5108b40d5ff7c3..c45ede2424b48b2396026f5a2c3906a1cf74a7aa 100644 (file)
--- a/taglib/mod/modfile.h
+++ b/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.

diff --git a/taglib/ogg/oggfile.h b/taglib/ogg/oggfile.h
index b36daecb1dbd93bdb5f4cd04860d908f926ca259..8fed4ba0937c702ec02605fb6ab62b256646643c 100644 (file)
--- a/taglib/ogg/oggfile.h
+++ b/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

diff --git a/taglib/s3m/s3mfile.h b/taglib/s3m/s3mfile.h
index 027328810c57a6a73f879c4462e4a903e08405eb..5f452977213f0800a616d3a8c6a30a9fa0503577 100644 (file)
--- a/taglib/s3m/s3mfile.h
+++ b/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.

diff --git a/taglib/toolkit/tbytevector.h b/taglib/toolkit/tbytevector.h
index 4a0f2b91143b560fbe3ce2eb087e691f7c80f45e..538565b0a6ea2cb759d2f526c448e8a64dcebaf6 100644 (file)
--- a/taglib/toolkit/tbytevector.h
+++ b/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);
 

diff --git a/taglib/wavpack/wavpackfile.h b/taglib/wavpack/wavpackfile.h
index c507977e24d9c38eccf99b067b65b9cdd3b75916..95a28bc64567b341f7499033b1ed200d98284ab4 100644 (file)
--- a/taglib/wavpack/wavpackfile.h
+++ b/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);
 

diff --git a/taglib/xm/xmfile.h b/taglib/xm/xmfile.h
index 95871d3a1587030122e95bc3afd04de029b5ca35..ae48a511dfd4cd8a3aac7d6f67e9409423f55611 100644 (file)
--- a/taglib/xm/xmfile.h
+++ b/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.