Cleanup playlist.c/.h

This commit is contained in:
twinaphex 2015-01-17 03:48:59 +01:00
parent 16b0a7dc83
commit 890e86293c
2 changed files with 18 additions and 12 deletions

View File

@ -41,7 +41,7 @@ struct content_playlist
/**
* content_playlist_get_index:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
* @idx : Index of playlist entry.
* @path : Path of playlist entry.
* @core_path : Core path of playlist entry.
@ -65,6 +65,12 @@ void content_playlist_get_index(content_playlist_t *playlist,
*core_name = playlist->entries[idx].core_name;
}
/**
* content_playlist_free_entry:
* @entry : Playlist entry handle.
*
* Frees playlist entry.
**/
static void content_playlist_free_entry(
struct content_playlist_entry *entry)
{
@ -86,7 +92,7 @@ static void content_playlist_free_entry(
/**
* content_playlist_push:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
* @path : Path of new playlist entry.
* @core_path : Core path of new playlist entry.
* @core_name : Core name of new playlist entry.
@ -172,7 +178,7 @@ static void content_playlist_write_file(content_playlist_t *playlist)
/**
* content_playlist_free:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
*
* Frees playlist handle.
*/
@ -196,7 +202,7 @@ void content_playlist_free(content_playlist_t *playlist)
/**
* content_playlist_clear:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
*
* Clears all playlist entries in playlist.
**/
@ -213,7 +219,7 @@ void content_playlist_clear(content_playlist_t *playlist)
/**
* content_playlist_size:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
*
* Gets size of playlist.
* Returns: size of playlist.
@ -273,7 +279,7 @@ end:
/**
* content_playlist_init:
* @path : Path to playlist contents file.
* @path : Path to playlist contents file.
* @size : Maximum capacity of playlist size.
*
* Creates and initializes a playlist.

View File

@ -28,7 +28,7 @@ typedef struct content_playlist content_playlist_t;
/**
* content_playlist_init:
* @path : Path to playlist contents file.
* @path : Path to playlist contents file.
* @size : Maximum capacity of playlist size.
*
* Creates and initializes a playlist.
@ -39,7 +39,7 @@ content_playlist_t *content_playlist_init(const char *path, size_t size);
/**
* content_playlist_free:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
*
* Frees playlist handle.
*/
@ -47,7 +47,7 @@ void content_playlist_free(content_playlist_t *playlist);
/**
* content_playlist_clear:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
*
* Clears all playlist entries in playlist.
**/
@ -55,7 +55,7 @@ void content_playlist_clear(content_playlist_t *playlist);
/**
* content_playlist_size:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
*
* Gets size of playlist.
* Returns: size of playlist.
@ -64,7 +64,7 @@ size_t content_playlist_size(content_playlist_t *playlist);
/**
* content_playlist_get_index:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
* @idx : Index of playlist entry.
* @path : Path of playlist entry.
* @core_path : Core path of playlist entry.
@ -79,7 +79,7 @@ void content_playlist_get_index(content_playlist_t *playlist,
/**
* content_playlist_push:
* @playlist : Playlist handle.
* @playlist : Playlist handle.
* @path : Path of new playlist entry.
* @core_path : Core path of new playlist entry.
* @core_name : Core name of new playlist entry.