From fa643093bd1b8804bac27a2143ed27f3d39c79f3 Mon Sep 17 00:00:00 2001
From: Allan Sandfeld Jensen <kde@carewolf.com>
Date: Thu, 2 Sep 2004 19:32:19 +0000
Subject: [PATCH] Cleaning up. Better documentation and remove dead code.

git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@343588 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
---
 ape/apetag.cpp | 16 ----------------
 ape/apetag.h   | 12 +++++++++++-
 2 files changed, 11 insertions(+), 17 deletions(-)

diff --git a/ape/apetag.cpp b/ape/apetag.cpp
index 0d69a9f5..94df2b13 100644
--- a/ape/apetag.cpp
+++ b/ape/apetag.cpp
@@ -30,22 +30,6 @@
 
 using namespace TagLib;
 using namespace APE;
-/*
-static StringList parseAPEString(const ByteVector &data)
-{
-  StringList value;
-  int pOld = 0;
-  int p = data.find('\0');
-
-  while (p != -1) {
-    value.append(String(data.mid(pOld, p), String::UTF8));
-    pOld = p + 1;
-    p = data.find('\0', pOld);
-  }
-  value.append(String(data.mid(pOld), String::UTF8));
-
-  return value;
-}*/
 
 class APE::Tag::TagPrivate
 {
diff --git a/ape/apetag.h b/ape/apetag.h
index 7c6438bd..f10e4ebe 100644
--- a/ape/apetag.h
+++ b/ape/apetag.h
@@ -103,6 +103,15 @@ namespace TagLib {
        */
       Footer *footer() const;
 
+      /*!
+       * Returns a reference to the item list map.  This is an ItemListMap of
+       * all of the items in the tag.
+       *
+       * This is the most powerfull structure for accessing the items of the tag.
+       *
+       * \warning You should not modify this data structure directly, instead
+       * use setItem() and removeItem().
+       */
       const ItemListMap &itemListMap() const;
 
       /*!
@@ -118,7 +127,8 @@ namespace TagLib {
       void addValue(const String &key, const String &value, bool replace = true);
 
       /*!
-       * Sets the \a key comment to \a item.
+       * Sets the \a key item to the value of \a item. If an item with the \a key is already
+       * present, it will be replaced.
        */
       void setItem(const String &key, const Item &item);