mirror/taglib
1
0
Fork 0
mirror of https://github.com/taglib/taglib.git synced 2025-05-27 21:20:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

Just a couple of docs updates.

Browse Source 
git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@457702 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
This commit is contained in:
Scott Wheeler 2005-09-06 11:39:26 +00:00
parent 78c4c18e37
commit 5d64692084
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
toolkit/taglib.h
View File

@ -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 <i>Abstract Factories</i> 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