From 88fcd14d3687d15752c1db308a81e7264745d56c Mon Sep 17 00:00:00 2001
From: trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38>
Date: Sat, 1 Aug 2015 12:24:10 +0000
Subject: fixed api documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@5299 90c681e8-e032-0410-971d-27865f9a5e38
---
 src/qmmpui/playlisttrack.h | 30 ++++++++++++++++++++++++------
 1 file changed, 24 insertions(+), 6 deletions(-)

(limited to 'src/qmmpui/playlisttrack.h')

diff --git a/src/qmmpui/playlisttrack.h b/src/qmmpui/playlisttrack.h
index 304445d20..2c832f616 100644
--- a/src/qmmpui/playlisttrack.h
+++ b/src/qmmpui/playlisttrack.h
@@ -58,6 +58,9 @@ public:
      * @param column Number of column.
      */
     const QString formattedTitle(int column);
+    /*!
+     * Returns the list of the formatted titles for all columns.
+     */
     const QStringList formattedTitles();
     /*!
      *  Returns formatted length of the item.
@@ -92,17 +95,32 @@ public:
      * Returns \b false.
      */
     bool isGroup() const;
-
+    /*!
+     * Sets the index of the track.
+     */
     void setTrackIndex(int track_index);
-
+    /*!
+     * Returns the index of the track.
+     * Default implementation returns -1.
+     */
     int trackIndex() const;
-
-
+    /*!
+     * Prepares for usage.
+     * Increases reference counter.
+     */
     void beginUsage();
+    /*!
+     * End of usage.
+     * Decreases reference counter.
+     */
     void endUsage();
+    /*!
+     * Shedules track object for deletion.
+     */
     void deleteLater();
-
-
+    /*!
+     * Returns \b true if the track object is sheduled for deletion.
+     */
     bool isSheduledForDeletion() const;
     /*!
      * Indicates that instance is currently busy in some kind of operation (tags editing etc.)
-- 
cgit v1.2.3-13-gbd6f