]> granicus.if.org Git - taglib/commitdiff
Fix some comments.
authorTsuda Kageyu <tsuda.kageyu@gmail.com>
Sat, 1 Aug 2015 18:24:25 +0000 (03:24 +0900)
committerTsuda Kageyu <tsuda.kageyu@gmail.com>
Sat, 1 Aug 2015 18:24:25 +0000 (03:24 +0900)
taglib/flac/flacfile.h
taglib/toolkit/tbytevector.h

index e2d158429a5a7316ef1f3b5069bf35f3b566ec8e..dc0a9601734055be33d9e4e71a456d38a2e3f4ad 100644 (file)
@@ -79,7 +79,7 @@ namespace TagLib {
            Properties::ReadStyle propertiesStyle = Properties::Average);
 
       /*!
-       * Constructs an APE file from \a file.  If \a readProperties is true the
+       * Constructs an FLAC file from \a file.  If \a readProperties is true the
        * file's audio properties will also be read.
        *
        * If this file contains and ID3v2 tag the frames will be created using
index 2ac3545bda5a8033d078516cb20b1cc305ccc904..793b414cecbed35d86f9d35559660f166d70256a 100644 (file)
@@ -85,9 +85,10 @@ namespace TagLib {
 
     /*!
      * Constructs a byte vector that copies \a data up to the first null
-     * byte.  The behavior is undefined if \a data is not null terminated.
-     * This is particularly useful for constructing byte arrays from string
-     * constants.
+     * byte.  This is particularly useful for constructing byte arrays from
+     * string constants.
+     *
+     * \warning The behavior is undefined if \a data is not null terminated.
      */
     ByteVector(const char *data);
 
@@ -550,12 +551,14 @@ namespace TagLib {
     ByteVector &operator=(const ByteVector &v);
 
     /*!
-     * Copies ByteVector \a v.
+     * Copies a byte \a c.
      */
     ByteVector &operator=(char c);
 
     /*!
-     * Copies ByteVector \a v.
+     * Copies \a data up to the first null byte.
+     *
+     * \warning The behavior is undefined if \a data is not null terminated.
      */
     ByteVector &operator=(const char *data);