From b29a821ed45da92f8b42d1ebcb19ae084fc34638 Mon Sep 17 00:00:00 2001 From: Scott Wheeler Date: Thu, 13 May 2004 00:08:00 +0000 Subject: [PATCH] documentation fixes git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@310850 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- ogg/flac/oggflacfile.h | 12 ++++++------ toolkit/tstring.h | 6 +++++- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/ogg/flac/oggflacfile.h b/ogg/flac/oggflacfile.h index 61138435..5ef7f8a4 100644 --- a/ogg/flac/oggflacfile.h +++ b/ogg/flac/oggflacfile.h @@ -30,17 +30,17 @@ namespace TagLib { class Tag; - //! An implementation of Ogg/FLAC metadata + namespace Ogg { + + //! An implementation of Ogg FLAC metadata /*! - * This is implementation of FLAC metadata for Ogg/FLAC files. For native + * This is implementation of FLAC metadata for Ogg FLAC files. For "pure" * FLAC files look under the FLAC hiearchy. * - * Unlike native FLAC-files, Ogg/FLAC only supports Xiph-comments, + * Unlike "pure" FLAC-files, Ogg FLAC only supports Xiph-comments, * while the audio-properties are the same. */ - - namespace Ogg { namespace FLAC { using TagLib::FLAC::Properties; @@ -51,7 +51,7 @@ namespace TagLib { * This implements and provides an interface for Ogg/FLAC files to the * TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing * the abstract TagLib::File API as well as providing some additional - * information specific to Ogg/FLAC files. + * information specific to Ogg FLAC files. */ class File : public TagLib::Ogg::File diff --git a/toolkit/tstring.h b/toolkit/tstring.h index db3f790b..d1b92039 100644 --- a/toolkit/tstring.h +++ b/toolkit/tstring.h @@ -28,11 +28,15 @@ #include /*! + * \relates TagLib::String + * * Converts a TagLib::String to a QString without a requirement to link to Qt. */ #define QStringToTString(s) TagLib::String(s.utf8().data(), TagLib::String::UTF8) /*! + * \relates TagLib::String + * * Converts a TagLib::String to a QString without a requirement to link to Qt. */ #define TStringToQString(s) QString::fromUtf8(s.toCString(true)) @@ -325,7 +329,7 @@ namespace TagLib { static String null; protected: - /* + /*! * If this String is being shared via implicit sharing, do a deep copy of the * data and separate from the shared members. This should be called by all * non-const subclass members.