From: Scott Wheeler <wheeler@kde.org>
Date: Mon, 16 Jun 2008 14:21:03 +0000 (+0000)
Subject: Add a warning here so that it's clear that this constructor is not to be used for... 
X-Git-Tag: v1.6rc1~68
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=be99222f293ecccdd0cb62b8cc8e5e4c5190e2ad;p=taglib

Add a warning here so that it's clear that this constructor is not to be used for setting the
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 9b4edf54..c4a16da4 100644
--- 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);