From 8329d6ac1a3e09efa784fde047826b76db82bd62 Mon Sep 17 00:00:00 2001 From: Michael Helmling Date: Thu, 27 Dec 2012 11:38:01 +0100 Subject: [PATCH] Update documentation of the property map interface in TagLib::File. --- taglib/toolkit/tfile.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/taglib/toolkit/tfile.h b/taglib/toolkit/tfile.h index 4b231d06..30e53f93 100644 --- a/taglib/toolkit/tfile.h +++ b/taglib/toolkit/tfile.h @@ -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