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

Update documentation of the property map interface in TagLib::File.

Browse Source
This commit is contained in:
Michael Helmling
2012-12-27 11:38:01 +01:00
parent f1d723077f
commit 8329d6ac1a
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
taglib/toolkit/tfile.h
View File

@ -86,6 +86,8 @@ namespace TagLib {
* format, the returend map's unsupportedData() list will contain one entry identifying
* that object (e.g. the frame type for ID3v2 tags). Use removeUnsupportedProperties()
* to remove (a subset of) them.
* For files that contain more than one tag (e.g. an MP3 with both an ID3v2 and an ID3v2
* tag) only the most "modern" one will be exported (ID3v2 in this case).
* BIC: Will be made virtual in future releases.
*/
PropertyMap properties() const;
@ -107,11 +109,13 @@ namespace TagLib {
* indicating that no problems occured.
* With file types that support several tag formats (for instance, MP3 files can have
* ID3v1, ID3v2, and APEv2 tags), this function will create the most appropriate one
* and may remove deprecated ones (mostly ID3v1). See the documentation of the
* subclass implementations for detailed descriptions.
* (ID3v2 for MP3 files). Older formats will be updated as well, if they exist, but won't
* be taken into account for the return value of this function.
* See the documentation of the subclass implementations for detailed descriptions.
* BIC: will become pure virtual in the future
*/
PropertyMap setProperties(const PropertyMap &properties);
/*!
* Returns a pointer to this file's audio properties. This should be
* reimplemented in the concrete subclasses. If no audio properties were