From 68a50fe314213ae561bcdef1bbf637ba6e25fa31 Mon Sep 17 00:00:00 2001
From: trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38>
Date: Sat, 1 Aug 2015 09:48:37 +0000
Subject: updated api documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@5297 90c681e8-e032-0410-971d-27865f9a5e38
---
 src/qmmp/output.h         |  6 ++++--
 src/qmmpui/playlistitem.h | 17 +++++++++++++----
 2 files changed, 17 insertions(+), 6 deletions(-)

(limited to 'src')

diff --git a/src/qmmp/output.h b/src/qmmp/output.h
index 96949e799..c2e8bf278 100644
--- a/src/qmmp/output.h
+++ b/src/qmmp/output.h
@@ -83,10 +83,12 @@ public:
      */
     quint32 sampleRate() const;
     /*!
-     * Returns channels number.
+     * Returns number of channels.
      */
     int channels() const;
-
+    /*!
+     * Returns required channel map.
+     */
     const ChannelMap channelMap() const;
     /*!
      * Returns selected audio format.
diff --git a/src/qmmpui/playlistitem.h b/src/qmmpui/playlistitem.h
index b5af7384d..b538b40e8 100644
--- a/src/qmmpui/playlistitem.h
+++ b/src/qmmpui/playlistitem.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2008-2013 by Ilya Kotov                                 *
+ *   Copyright (C) 2008-2015 by Ilya Kotov                                 *
  *   forkotov02@hotmail.ru                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -53,7 +53,10 @@ public:
      * @param column Number of column.
      */
     virtual const QString formattedTitle(int column) = 0;
-
+    /*!
+     * Returns the list of the formatted titles for all columns.
+     * Group separators contain only one title.
+     */
     virtual const QStringList formattedTitles() = 0;
     /*!
      *  Returns formatted length of the item.
@@ -63,9 +66,15 @@ public:
      * Returns \b true if the \b PlayListItem is group separator. Otherwise returns \b false.
      */
     virtual bool isGroup() const = 0;
-
+    /*!
+     * Sets the index of the track.
+     * Default implementation does nothing.
+     */
     virtual void setTrackIndex(int number);
-
+    /*!
+     * Returns the index of the track.
+     * Default implementation returns -1.
+     */
     virtual int trackIndex() const;
 
 private:
-- 
cgit v1.2.3-13-gbd6f