Documentation update: GraphicsAudioItem

src/Gui/timeline/GraphicsAudioItem.h

@@ -37,6 +37,9 @@ class GraphicsAudioItem : public AbstractGraphicsMediaItem
 {
     Q_OBJECT
 public:
+    /**
+     * \brief See http://doc.trolltech.com/4.5/qgraphicsitem.html#type
+     */
     enum { Type = UserType + 1 };
     GraphicsAudioItem( Clip* clip );
     virtual ~GraphicsAudioItem();
@@ -54,7 +57,17 @@ public:
     virtual Clip* clip() const;
 
 protected:
+    /**
+     * \brief Paint the item's rectangle.
+     * \param painter Pointer to a QPainter.
+     * \param option Painting options.
+     */
     void                paintRect( QPainter* painter, const QStyleOptionGraphicsItem* option );
+    /**
+     * \brief Paint the item's title.
+     * \param painter Pointer to a QPainter.
+     * \param option Painting options.
+     */
     void                paintTitle( QPainter* painter, const QStyleOptionGraphicsItem* option );
     virtual void        hoverEnterEvent( QGraphicsSceneHoverEvent* event );
     virtual void        hoverLeaveEvent( QGraphicsSceneHoverEvent* event );
@@ -62,6 +75,9 @@ protected:
     virtual void        mouseReleaseEvent( QGraphicsSceneMouseEvent* event );
 
 private slots:
+    /**
+     * \deprecated Do not use.
+     */
     void                adjustLength();
 
 private:
@@ -70,6 +86,11 @@ private:
     int                 m_height;
 
 signals:
+    /**
+     * \brief Emitted when the item detect a cut request.
+     * \param self A pointer to the sender.
+     * \param frame Frame's number where the cut takes place.
+     */
     void                split( GraphicsAudioItem* self, qint64 frame );
 };