fixed api documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@4270 90c681e8-e032-0410-971d-27865f9a5e38

1 files changed, 56 insertions, 6 deletions

diff --git a/src/qmmpui/playlistgroup.h b/src/qmmpui/playlistgroup.h
index dbd21b806..8146b5aff 100644
--- a/src/qmmpui/playlistgroup.h
+++ b/src/qmmpui/playlistgroup.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2013 by Ilya Kotov                                      *
+ *   Copyright (C) 2013-2014 by Ilya Kotov                                 *
  *   forkotov02@hotmail.ru                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -24,32 +24,82 @@
 #include "playlisttrack.h"
 #include "playlistitem.h"
 
+/** @brief The PlayListTrack class provides a group for use with the PlayListModel class.
+ * @author Ilya Kotov <forkotov02@hotmail.ru>
+ */
 class PlayListGroup : public PlayListItem
 {
 public:
+    /*!
+     * Constructor.
+     * @param formattedTitle Title of the group.
+     */
     PlayListGroup(const QString &formattedTitle);
-
+    /*!
+     * Object destructor.
+     */
     virtual ~PlayListGroup();
-
+    /*!
+     * First index of the group.
+     */
     int firstIndex;
+    /*!
+     * Last index of the  group.
+     */
     int lastIndex;
-
+    /*!
+     * Returns formatted title of the  group.
+     */
     const QString formattedTitle();
+    /*!
+     * Adds track \b track to the the group.
+     */
     void addTrack(PlayListTrack *track);
+    /*!
+     * Adds a list of tracks \b tracks to the the group.
+     */
     void addTracks(QList<PlayListTrack *> tracks);
+    /*!
+     * Inserts a track \b tracks to the the group at the position \b pos.
+     */
     void insertTrack(int pos, PlayListTrack *track);
+    /*!
+     * Returns \b true if the group contains track \b track.
+     * Otherwise returns \b false.
+     */
     bool contains(PlayListTrack *track) const;
+    /*!
+     * Returns \b true if the group is empty.
+     * Otherwise returns \b false.
+     */
     bool isEmpty() const;
+    /*!
+     * Returns track \b track from the group.
+     */
     void remove(PlayListTrack *track);
+    /*!
+     * Returns a list of tracks if the group.
+     */
     QList<PlayListTrack *> tracks();
+    /*!
+     * Returns number of tracks if the group.
+     */
     int count() const;
     /*!
      *  Returns formatted length of the item.
      */
     const QString formattedLength() { return QString(); }
-    virtual bool isGroup() const { return true; }
+    /*!
+     * Returns \b true.
+     */
+    bool isGroup() const;
+    /*!
+     * Moves the track from position \b from to position \b to.
+     */
     void move(int from, int to);
-
+    /*!
+     * Removes all tracks from the group and returns a list of them.
+     */
     QList<PlayListTrack *> takeAll();
 
 private: