changeset 21424:3504737c4e96

doxygenized dvdnav_sid_from_lang() and dvdnav_number_of_subs()
author nicodvb
date Sat, 02 Dec 2006 14:50:12 +0000
parents db712772c7cc
children 97d17ae56707
files stream/stream_dvdnav.c
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/stream/stream_dvdnav.c	Sat Dec 02 14:00:41 2006 +0000
+++ b/stream/stream_dvdnav.c	Sat Dec 02 14:50:12 2006 +0000
@@ -467,6 +467,12 @@
   priv->mousey = y;
 }
 
+/**
+ * \brief dvdnav_sid_from_lang() returns the subtitle id corresponding to the language code 'lang'
+ * \param stream: - stream pointer
+ * \param lang: 2-characters language code[s], eventually separated by spaces of commas
+ * \return -1 on error, current subtitle id if successful
+ */
 int dvdnav_sid_from_lang(stream_t *stream, unsigned char *language) {
   dvdnav_priv_t * priv=(dvdnav_priv_t*)stream->priv;
   uint8_t format, lg, k;
@@ -488,6 +494,11 @@
   return -1;
 }
 
+/**
+ * \brief dvdnav_number_of_subs() returns the count of available subtitles
+ * \param stream: - stream pointer
+ * \return 0 on error, something meaningful otherwise
+ */
 int dvdnav_number_of_subs(stream_t *stream) {
   dvdnav_priv_t * priv=(dvdnav_priv_t*)stream->priv;
   uint8_t lg, k, n=0;