mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2025-07-21 14:34:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixed comments for File constructors

Browse Source
This commit is contained in:
Tsuda Kageyu
2013-05-30 02:04:10 +09:00
parent cf9f2a436b
commit f77a84486e
18 changed files with 171 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
taglib/xm/xmfile.h
View File

@ -36,18 +36,20 @@ namespace TagLib {
class TAGLIB_EXPORT File : public Mod::FileBase {
public:
/*!
* Contructs a Extended Module 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 Extended Module file from \a file.
*
* \note In the current implementation, both \a readProperties and
* \a propertiesStyle are ignored.
*/
File(FileName file, bool readProperties = true,
AudioProperties::ReadStyle propertiesStyle =
AudioProperties::Average);
/*!
* Contructs a Extended Module file from \a stream. 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 Extended Module file from \a stream.
*
* \note In the current implementation, both \a readProperties and
* \a propertiesStyle are ignored.
*
* \note TagLib will *not* take ownership of the stream, the caller is
* responsible for deleting it after the File object.