From: Scott Wheeler <wheeler@kde.org>
Date: Thu, 31 Jan 2008 15:47:10 +0000 (+0000)
Subject: SVN_SILENT docs
X-Git-Tag: v1.5~42
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7997d2cc4003fca9bcd3383f110a5237513ee98a;p=taglib

SVN_SILENT docs


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

diff --git a/taglib/mpeg/id3v2/id3v2framefactory.h b/taglib/mpeg/id3v2/id3v2framefactory.h
index 1e2c9fa3..438a3e21 100644
--- a/taglib/mpeg/id3v2/id3v2framefactory.h
+++ b/taglib/mpeg/id3v2/id3v2framefactory.h
@@ -37,7 +37,7 @@ namespace TagLib {
 
     class TAGLIB_EXPORT TextIdentificationFrame;
 
-    //! A factory for creating ID3v2 frames
+    //! A factory for creating ID3v2 frames during parsing
 
     /*!
      * This factory abstracts away the frame creation process and instantiates
@@ -54,6 +54,12 @@ namespace TagLib {
      * This implements both <i>abstract factory</i> and <i>singleton</i> patterns
      * of which more information is available on the web and in software design
      * textbooks (Notably <i>Design Patters</i>).
+     *
+     * \note You do not need to use this factory to create new frames to add to
+     * an ID3v2::Tag.  You can instantiate frame subclasses directly (with new)
+     * and add them to a tag using ID3v2::Tag::addFrame()
+     *
+     * \see ID3v2::Tag::addFrame()
      */
 
     class TAGLIB_EXPORT FrameFactory