]> granicus.if.org Git - taglib/commitdiff
documentation fixes
authorScott Wheeler <wheeler@kde.org>
Thu, 13 May 2004 00:08:00 +0000 (00:08 +0000)
committerScott Wheeler <wheeler@kde.org>
Thu, 13 May 2004 00:08:00 +0000 (00:08 +0000)
git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@310850 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

ogg/flac/oggflacfile.h
toolkit/tstring.h

index 6113843505e9c462537ca34f034a142ff2e4c705..5ef7f8a4a16f3f6c1fab3a66f0213313e3c26b68 100644 (file)
@@ -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
index db3f790beeeea8028144d6d7ea3f777c745575cc..d1b920393a979c92a1c14109fb99b4b36a0eb268 100644 (file)
 #include <string>
 
 /*!
+ * \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.