Code reviews regarding playlist handling.

git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@171 e10066b5-e1e2-0310-b819-94efdf66514b

3 files changed, 31 insertions, 8 deletions

diff --git a/TODO b/TODO
index 9a4817c..7b4a54f 100644
--- a/TODO
+++ b/TODO
@@ -12,12 +12,16 @@
     \subsection bugs Bugs and testing needed
     
     - Test execution of playlist commands
+    - Test Save/Rename/Load of playlist
+    - Plugin crashes when selecting entries with special characters
+      - Escape query strings correctly
+    - Do not allow playlist deletion while playing or stop or similar
     - Keep this? Test mgPCMPlayer::getSourceFile() for GD case (find)
-    - Test saving/loading playlists to database
 
     \subsection urgentosd OSD-related Issues
 
 	- Add play indicators
+	  - mgPCMPlayer::GetIndex: obtain total length from database
 	  - Toggle display with Ok (off -> track info -> album info -> playlist info -> off)
 	  - Display track info
 	    - Song title
diff --git a/gd_content_interface.c b/gd_content_interface.c
index 6c2f496..01e71b2 100644
--- a/gd_content_interface.c
+++ b/gd_content_interface.c
@@ -26,12 +26,17 @@
 
 using namespace std;
 
-#define GD_PLAYLIST_TYPE 0 // listtype for giant disc db
+#define GD_PLAYLIST_TYPE 0 //< listtype for giant disc db
 
 // some dummies to keep the compiler happy
 #define DUMMY_CONDITION true // we use that as dummy condition to satisfy C++ syntax
 #define DUMMY
 
+/*!
+ * \brief initialize a database used by Giantdisc
+ *
+ * \todo should be a static function in some Gd class
+ */
 int GdInitDatabase( MYSQL *db )
 {
   if( mysql_init(db) == NULL )
diff --git a/mg_playlist.h b/mg_playlist.h
index df677d4..a46d29d 100644
--- a/mg_playlist.h
+++ b/mg_playlist.h
@@ -3,9 +3,9 @@
  * \brief  defines functions to be executed on playlists for the vdr muggle plugindatabase
  *
  * \version $Revision: 1.6 $
- * \date    $Date: 2004/07/26 22:20:55 $
+ * \date    $Date$
  * \author  Ralf Klueber, Lars von Wedel, Andreas Kellner
- * \author  Responsible author: $Author: lvw $
+ * \author  Responsible author: $Author$
  *
  * This file implements the class mgPlaylist which maintains a playlist
  * and supports editing (e.g. adding or moving tracks), navigating it
@@ -23,7 +23,9 @@
  * \class mgPlaylist
  *
  * \brief Represents a generic playlist, i.e. an ordered collection of tracks
- * Derived classes take care of specifics of certain media types
+ *        Derived classes may take care of specifics of certain media types
+ *
+ * \todo Are loop mode, shuffle mode, and party mode implemented here?
  */
 class mgPlaylist : public mgTracklist
 {	  
@@ -112,7 +114,11 @@ public:
   //! \brief obtain the listname
   std::string getListname() ;
 
-  //! \brief returns the current item of the list
+  /*! 
+   * \brief returns the current item of the list
+   *
+   * \todo Return null in case of an empty list or invalid index
+   */
   virtual mgContentItem* getCurrent();
     
   /*! \brief set the listname
@@ -130,10 +136,18 @@ public:
    */
   virtual void gotoPosition(unsigned int position);
   
-  //! \brief proceeds to the next item
+  /*!
+   * \brief proceeds to the next item
+   * 
+   * \todo Handle loop mode
+   */
   virtual void skipFwd();
 
-  //! \brief goes back to the previous item
+  /*! 
+   * \brief goes back to the previous item
+   *
+   * \todo Handle loop mode
+   */
   virtual void skipBack();
  
   //! \brief obtain the next item without skipping the current position