changeset 16032:c5a629a2f33c

Forgotten doxygen comments
author reimar
date Wed, 20 Jul 2005 17:14:45 +0000
parents c2e78215f0d9
children 2571bac1617e
files libmpdemux/http.c
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libmpdemux/http.c	Wed Jul 20 17:12:33 2005 +0000
+++ b/libmpdemux/http.c	Wed Jul 20 17:14:45 2005 +0000
@@ -65,6 +65,12 @@
   return pos;
 }
 
+/**
+ * \brief read and process (i.e. discard *g*) a block of ultravox metadata
+ * \param fd file descriptor to read from
+ * \param sc streaming_ctrl_t whose buffer is consumed before reading from fd
+ * \return number of real data before next metadata block starts or 0 on error
+ */
 static unsigned uvox_meta_read(int fd, streaming_ctrl_t *sc) {
   unsigned metaint;
   unsigned char info[6];
@@ -93,6 +99,8 @@
 
 /**
  * \brief read one scast meta data entry and print it
+ * \param fd file descriptor to read from
+ * \param sc streaming_ctrl_t whose buffer is consumed before reading from fd
  */
 static void scast_meta_read(int fd, streaming_ctrl_t *sc) {
   unsigned char tmp = 0;
@@ -108,6 +116,13 @@
   }
 }
 
+/**
+ * \brief read data from scast/ultravox stream without any metadata
+ * \param fd file descriptor to read from
+ * \param buffer buffer to read data into
+ * \param size number of bytes to read
+ * \param sc streaming_ctrl_t whose buffer is consumed before reading from fd
+ */
 static int scast_streaming_read(int fd, char *buffer, int size,
                                 streaming_ctrl_t *sc) {
   scast_data_t *sd = (scast_data_t *)sc->data;