Add a warning here so that it's clear that this constructor is not to be used for...

object's data.

git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@821128 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

diff --git a/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h b/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h
index 9b4edf5456e2650be53d6efe09a05a63e5a26dff..c4a16da4418c8596f5d1ddf08c2c5fd99b342f17 100644 (file)
--- a/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h
+++ b/taglib/mpeg/id3v2/frames/generalencapsulatedobjectframe.h
@@ -61,6 +61,10 @@ namespace TagLib {
 
       /*!
        * Constructs a GeneralEncapsulatedObjectFrame frame based on \a data.
+       *
+       * \warning This is \em not data for the encapsulated object, for that use
+       * setObject().  This construcotr is used when reading the frame from the
+       * disk.
        */
       explicit GeneralEncapsulatedObjectFrame(const ByteVector &data);