Commit 3f23a657 authored by Alexandre Janniaux's avatar Alexandre Janniaux Committed by Rémi Denis-Courmont
Browse files

playlist: add randomizer to documentation


Signed-off-by: Rémi Denis-Courmont's avatarRémi Denis-Courmont <remi@remlab.net>
parent 0d16d1ad
......@@ -32,7 +32,11 @@
#include <vlc_rand.h>
#include "randomizer.h"
/* Playlist helper to manage random playback.
/**
* \addtogroup playlist_randomizer Playlist randomizer helper
* \ingroup playlist
*
* Playlist helper to manage random playback.
*
* The purpose is to guarantee the following rules:
* - an item must never be selected twice
......@@ -550,6 +554,7 @@ randomizer_Clear(struct randomizer *r)
r->history = 0;
}
#ifndef DOC
#ifdef TEST_RANDOMIZER
/* fake structure to simplify tests */
......@@ -1122,3 +1127,4 @@ int main(void)
}
#endif
#endif
......@@ -26,6 +26,11 @@
typedef struct vlc_playlist_item vlc_playlist_item_t;
/**
* \defgroup playlist_randomizer Playlist randomizer helper
* \ingroup playlist
* @{ */
/**
* Playlist helper to manage random playback.
*
......@@ -145,4 +150,6 @@ randomizer_Remove(struct randomizer *randomizer,
void
randomizer_Clear(struct randomizer *randomizer);
/** @} */
#endif
......@@ -18,6 +18,8 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifndef DOC
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
......@@ -2280,3 +2282,5 @@ int main(void)
test_sort();
return 0;
}
#endif
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment