Add docs.

git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@306915 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

diff --git a/mpeg/id3v2/frames/relativevolumeframe.h b/mpeg/id3v2/frames/relativevolumeframe.h
index 55d2100eb3087e36ae62c7bcc14ed8fa65dc03f5..6c5360a2f031d82df813df29e0d2dd418279dfcf 100644 (file)
--- a/mpeg/id3v2/frames/relativevolumeframe.h
+++ b/mpeg/id3v2/frames/relativevolumeframe.h
@@ -28,43 +28,163 @@ namespace TagLib {
 
   namespace ID3v2 {
 
+    //! An ID3v2 relative volume adjustment frame implementation
+
+    /*!
+     * This is an implementation of ID3v2 relative volume adjustment.  The
+     * presense of this frame makes it possible to specify an increase in volume
+     * for an audio file or specific audio tracks in that file.
+     *
+     * Multiple relative volume adjustment frames may be present in the tag
+     * each with a unique identification and describing volume adjustment for
+     * different channel types.
+     */
+
     class RelativeVolumeFrame : public Frame
     {
       friend class FrameFactory;
 
     public:
 
+      /*!
+       * This indicates the type of volume adjustment that should be applied.
+       */
       enum ChannelType {
+        //! A type not enumerated below
         Other        = 0x00,
+        //! The master volume for the track
         MasterVolume = 0x01,
+        //! The front right audio channel
         FrontRight   = 0x02,
+        //! The front left audio channel
         FrontLeft    = 0x03,
+        //! The back right audio channel
         BackRight    = 0x04,
+        //! The back left audio channel
         BackLeft     = 0x05,
+        //! The front center audio channel
         FrontCentre  = 0x06,
+        //! The back center audio channel
         BackCentre   = 0x07,
+        //! The subwoofer audio channel
         Subwoofer    = 0x08
       };
 
+      /*!
+       * The peak volume is described as a series of bits that is padded to fill
+       * a block of bytes.  These two values should always be updated in tandem.
+       */
       struct PeakVolume
       {
+        /*!
+         * Constructs an empty peak volume description.
+         */
         PeakVolume() : bitsRepresentingPeak(0) {}
+        /*!
+         * The number of bits (in the range of 0 to 255) used to describe the
+         * peak volume.
+         */
         unsigned char bitsRepresentingPeak;
+        /*!
+         * The array of bits (represented as a series of bytes) used to describe
+         * the peak volume.
+         */
         ByteVector peakVolume;
       };
 
+      /*!
+       * Constructs a RelativeVolumeFrame.  The relevant data should be set
+       * manually.
+       */
+      RelativeVolumeFrame();
+
+      /*!
+       * Constructs a RelativeVolumeFrame based on the contents of \a data.
+       */
       RelativeVolumeFrame(const ByteVector &data);
+
+      /*!
+       * Destroys the RelativeVolumeFrame instance.
+       */
       virtual ~RelativeVolumeFrame();
 
+      /*!
+       * Returns the frame's identification.
+       *
+       * \see identification()
+       */
       virtual String toString() const;
 
+      /*!
+       * Returns the channel type that this frame refers to.
+       *
+       * \see setChannelType()
+       */
       ChannelType channelType() const;
+
+      /*!
+       * Sets the channel type that this frame refers to.
+       *
+       * \see channelType()
+       */
       void setChannelType(ChannelType t);
+
+      /*!
+       * Returns the relative volume adjustment "index".  As indicated by the
+       * ID3v2 standard this is a 16-bit signed integer that reflects the
+       * decibils of adjustment when divided by 512.
+       *
+       * \see setVolumeAdjustmentIndex()
+       * \see volumeAjustment()
+       */
       short volumeAdjustmentIndex() const;
+
+      /*!
+       * Set the volume adjustment to \a index.  As indicated by the ID3v2
+       * standard this is a 16-bit signed integer that reflects the decibils of
+       * adjustment when divided by 512.
+       *
+       * \see volumeAdjustmentIndex()
+       * \see setVolumeAjustment()
+       */
       void setVolumeAdjustmentIndex(short index);
+
+      /*!
+       * Returns the relative volume adjustment in decibels.
+       *
+       * \note Because this is actually stored internally as an "index" to this
+       * value the value returned by this method may not be identical to the
+       * value set using setVolumeAdjustment().
+       *
+       * \see setVolumeAdjustment()
+       * \see volumeAdjustmentIndex()
+       */
       float volumeAdjustment() const;
+
+      /*!
+       * Set the relative volume adjustment in decibels to \a adjustment.
+       *
+       * \note Because this is actually stored internally as an "index" to this
+       * value the value set by this method may not be identical to the one
+       * returned by volumeAdjustment().
+       *
+       * \see setVolumeAdjustment()
+       * \see volumeAdjustmentIndex()
+       */
       void setVolumeAdjustment(float adjustment);
+
+      /*!
+       * Returns the peak volume (represented as a length and a string of bits).
+       *
+       * \see setPeakVolume()
+       */
       PeakVolume peakVolume() const;
+
+      /*!
+       * Sets the peak volume to \a peak.
+       *
+       * \see peakVolume()
+       */
       void setPeakVolume(const PeakVolume &peak);
 
     protected: