Add some docs.

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

diff --git a/taglib/riff/rifffile.h b/taglib/riff/rifffile.h
index 9bb510498f4e57a47f7fc772d1d4d31924a649c8..c02e6ec7a06011118602f52af4e08fccd1966923 100644 (file)
--- a/taglib/riff/rifffile.h
+++ b/taglib/riff/rifffile.h
@@ -57,11 +57,37 @@ namespace TagLib {
 
       File(FileName file, Endianness endianness);
 
+      /*!
+       * \return The number of chunks in the file.
+       */
       uint chunkCount() const;
+
+      /*!
+       * \return The offset within the file for the selected chunk number.
+       */
       uint chunkOffset(uint i) const;
+
+      /*!
+       * \return The name of the specified chunk, for instance, "COMM" or "ID3 "
+       */
       ByteVector chunkName(uint i) const;
+
+      /*!
+       * Reads the chunk data from the file and returns it.
+       *
+       * \note This \e will move the read pointer for the file.
+       */
       ByteVector chunkData(uint i);
 
+      /*!
+       * Sets the data for the chunk \a name to \a data.  If a chunk with the
+       * given name already exists it will be overwritten, otherwise it will be
+       * created after the existing chunks.
+       *
+       * \warning This will update the file immediately.
+       */
+      void setChunkData(const ByteVector &name, const ByteVector &data);
+
     private:
       File(const File &);
       File &operator=(const File &);