From 5d64692084c2a5f4f6259580817d94d4268ed644 Mon Sep 17 00:00:00 2001 From: Scott Wheeler Date: Tue, 6 Sep 2005 11:39:26 +0000 Subject: [PATCH] Just a couple of docs updates. git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@457702 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- toolkit/taglib.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/toolkit/taglib.h b/toolkit/taglib.h index 49e51142..778b1dbd 100644 --- a/toolkit/taglib.h +++ b/toolkit/taglib.h @@ -86,9 +86,9 @@ namespace TagLib { * - Support for at least ID3v1, ID3v2 and Ogg Vorbis \e comments. * - A generic, \e simple API for the most common tagging related functions. * - Binary compatibility between minor releases using the standard KDE/Qt techniques for C++ binary compatibility. - * - Make the tagging framework extensible by library users; i.e. it will be possible for libarary users to implement + * - Make the tagging framework extensible by library users; i.e. it is possible for libarary users to implement * additional ID3v2 frames, without modifying the TagLib source (through the use of Abstract Factories and - * such. + * such). * * Because TagLib desires to be toolkit agnostic, in hope of being widely adopted and the most flexible in licensing * TagLib provides many of its own toolkit classes; in fact the only external dependancy that TagLib has, it a @@ -96,19 +96,15 @@ namespace TagLib { * * \section why Why TagLib? * - * TagLib was written to fill a gap in the Open Source/Free Software community. Currently there is a lack in the + * TagLib was written to fill a gap in the Open Source / Free Software community. Currently there is a lack in the * OSS/FS for a homogenous API to the most common music types. * - * As TagLib will be initially injected into the KDE community, while I am not linking to any of the KDE or Qt libraries - * I have tried to follow the coding style of those libraries. Again, this is in sharp contrast to id3lib, which - * basically provides a hybrid C/C++ API and uses a dubious object model. - * - * I get asked rather frequently why I am replacing id3lib (mostly by people that have never worked with id3lib), if - * you are concerned about this please email me; I can provide my lengthy standard rant. :-) + * As TagLib was initially injected into the KDE community, while I am not linking to any of the KDE or Qt libraries + * I have tried to follow the coding style of those libraries. * * \section examples Examples: * - * I've talked a lot about the \e homogenous API to common music formats. Here's an example of how things (will) work: + * I've talked a lot about the \e homogenous API to common music formats. Here's an example: * * \code * @@ -130,6 +126,10 @@ namespace TagLib { * future). For this high level API, which is suitable for most applications, the differences between tag and file * formats can all be ignored. * + * In addition to the high-level abstract APIs, there are also additional format specific APIs which allow users + * of the library to work with tags and audio properties in more powerful ways. See specifically the subclasses of + * TagLib::File, TagLib::Tag and TagLib::AudioProperties. + * * \section Building * * TagLib provides a script called taglib-config that returns the necessary compiler and linker flags, as well as the