changeset 34683:621058eff80f

Add doxygen comments to list.c.
author ib
date Thu, 23 Feb 2012 13:48:58 +0000
parents c3ab7bd64ab3
children b03481253518
files gui/util/list.c
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/gui/util/list.c	Thu Feb 23 13:30:16 2012 +0000
+++ b/gui/util/list.c	Thu Feb 23 13:48:58 2012 +0000
@@ -16,6 +16,11 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
+/**
+ * @file
+ * @brief List management
+ */
+
 #include <stdlib.h>
 #include <string.h>
 
@@ -27,6 +32,17 @@
 
 static urlItem *urlList;
 
+/**
+ * @brief Manage playlists and URL lists.
+ *
+ * @param cmd task to be performed
+ * @param data list item for the task
+ *
+ * @return pointer to top of list (GET command),
+ *         pointer to current list item (ITEM command) or
+ *         NULL (DELETE or unknown command)
+ *
+ */
 void *listMgr(int cmd, void *data)
 {
     plItem *pdat  = (plItem *)data;