From d302b299d13f960b57e3d9c23f8f84265ce3ac88 Mon Sep 17 00:00:00 2001 From: Scott Wheeler Date: Fri, 16 May 2008 05:29:38 +0000 Subject: [PATCH] Add some docs. git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@808236 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- taglib/riff/rifffile.h | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/taglib/riff/rifffile.h b/taglib/riff/rifffile.h index 9bb51049..c02e6ec7 100644 --- 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 &); -- 2.40.0