From: Tsuda Kageyu Date: Sat, 6 Feb 2016 12:14:12 +0000 (+0900) Subject: Add a supplementary note to a comment. X-Git-Tag: v1.11beta2~35 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fa46185ca4fd2c732a3db286e347a120dc78ff00;p=taglib Add a supplementary note to a comment. --- diff --git a/taglib/fileref.h b/taglib/fileref.h index 387b2f51..a12b1a9b 100644 --- a/taglib/fileref.h +++ b/taglib/fileref.h @@ -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,