diff options
author | albeu <albeu@b3059339-0415-0410-9bf9-f77b7e298cf2> | 2006-04-25 01:26:10 +0000 |
---|---|---|
committer | albeu <albeu@b3059339-0415-0410-9bf9-f77b7e298cf2> | 2006-04-25 01:26:10 +0000 |
commit | 400a9fab2e77b3a89819e642233cef53b83ccb0f (patch) | |
tree | cece1fb31d9b6e0a56faf75e2ad38f1655828bde /playtreeparser.h | |
parent | b2ca76bfb48a022ddef40cef2c53be39d1675ac0 (diff) | |
download | mpv-400a9fab2e77b3a89819e642233cef53b83ccb0f.tar.bz2 mpv-400a9fab2e77b3a89819e642233cef53b83ccb0f.tar.xz |
Doxygen Attack! - Chapter 3
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@18266 b3059339-0415-0410-9bf9-f77b7e298cf2
Diffstat (limited to 'playtreeparser.h')
-rw-r--r-- | playtreeparser.h | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/playtreeparser.h b/playtreeparser.h index b43f1c23fa..f038ea332c 100644 --- a/playtreeparser.h +++ b/playtreeparser.h @@ -1,4 +1,13 @@ +/// \defgroup PlaytreeParser Playtree parser +/// \ingroup Playtree +/// +/// The playtree parser allow to read various playlist formats. It read from +/// stream allowing to handle playlist from local files and the network. +///@{ + +/// \file + #ifndef __PLAYTREEPARSER_H #define __PLAYTREEPARSER_H @@ -11,17 +20,33 @@ typedef struct play_tree_parser { int deep,keep; } play_tree_parser_t; - +/// Create a new parser. +/** \param stream The stream to read from. + * \param deep Parser depth. Some format allow including other files, + * this is used to track the inclusion depth. + * \return The new parser. + */ play_tree_parser_t* play_tree_parser_new(struct stream_st* stream,int deep); +/// Destroy a parser. void play_tree_parser_free(play_tree_parser_t* p); +/// Build a playtree from the playlist opened with the parser. +/** \param p The parser. + * \param forced If non-zero the playlist file was explicitly + * given by the user, allow falling back on + * one filename per line playlist. + * \return A new playtree or NULL on error. + */ play_tree_t* play_tree_parser_get_play_tree(play_tree_parser_t* p, int forced); +/// Wrapper for play_tree_add_basepath (add base path from file). void play_tree_add_bpf(play_tree_t* pt, char* filename); #endif + +///@} |