]> granicus.if.org Git - taglib/commitdiff
Add a supplementary note to a comment.
authorTsuda Kageyu <tsuda.kageyu@gmail.com>
Sat, 6 Feb 2016 12:14:12 +0000 (21:14 +0900)
committerTsuda Kageyu <tsuda.kageyu@gmail.com>
Sat, 6 Feb 2016 12:14:12 +0000 (21:14 +0900)
taglib/fileref.h

index 387b2f518e6bc89d23ac5a58ce58c1439901aedd..a12b1a9b10d30d51a577a03a22c52e8a44492312 100644 (file)
@@ -128,13 +128,16 @@ namespace TagLib {
                      audioPropertiesStyle = AudioProperties::Average);
 
     /*!
-     * Construct a FileRef from an opened \a IOStream.  If \a readAudioProperties is true then
-     * the audio properties will be read using \a audioPropertiesStyle.  If
-     * \a readAudioProperties is false then \a audioPropertiesStyle will be
+     * Construct a FileRef from an opened \a IOStream.  If \a readAudioProperties
+     * is true then the audio properties will be read using \a audioPropertiesStyle.
+     * If \a readAudioProperties is false then \a audioPropertiesStyle will be
      * ignored.
      *
      * Also see the note in the class documentation about why you may not want to
      * use this method in your application.
+     *
+     * \note TagLib will *not* take ownership of the stream, the caller is
+     * responsible for deleting it after the File object.
      */
     explicit FileRef(IOStream* stream,
                      bool readAudioProperties = true,