vss.c: Documentation cleanup.
authorAndre Noll <maan@systemlinux.org>
Sun, 28 Oct 2007 01:41:54 +0000 (02:41 +0100)
committerAndre Noll <maan@systemlinux.org>
Sun, 28 Oct 2007 01:41:54 +0000 (02:41 +0100)
vss.c

diff --git a/vss.c b/vss.c
index 5dce4ca..03621e0 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file vss.c the virtual streaming system
+/** \file vss.c The virtual streaming system.
  *
  * This contains the audio streaming code of para_server which is independent
  * of the current audio format, audio file selector and of the activated
@@ -42,9 +42,9 @@ extern struct sender senders[];
 static char *map;
 
 /**
- * check if vss status flag \a P (playing) is set
+ * Check if vss status flag \a P (playing) is set.
  *
- * \return greater than zero if playing, zero otherwise.
+ * \return Greater than zero if playing, zero otherwise.
  *
  */
 unsigned int vss_playing(void)
@@ -53,9 +53,9 @@ unsigned int vss_playing(void)
 }
 
 /**
- * check if \a N (next) status flag is set
+ * Check if the \a N (next) status flag is set.
  *
- * \return greater than zero if set, zero if not.
+ * \return Greater than zero if set, zero if not.
  *
  */
 unsigned int vss_next(void)
@@ -64,9 +64,9 @@ unsigned int vss_next(void)
 }
 
 /**
- * check if a reposition request is pending
+ * Check if a reposition request is pending.
  *
- * \return greater than zero if true, zero otherwise.
+ * \return Greater than zero if true, zero otherwise.
  *
  */
 unsigned int vss_repos(void)
@@ -75,9 +75,9 @@ unsigned int vss_repos(void)
 }
 
 /**
- * check if the vss is currently paused
+ * Check if the vss is currently paused.
  *
- * \return greater than zero if paused, zero otherwise.
+ * \return Greater than zero if paused, zero otherwise.
  *
  */
 unsigned int vss_paused(void)
@@ -87,10 +87,10 @@ unsigned int vss_paused(void)
 }
 
 /**
- * initialize the virtual streaming system
+ * Initialize the virtual streaming system.
  *
- * Call the init functions of all supported audio format handlers and
- * initialize all supported senders.
+ * This also initializes all supported senders and starts streaming
+ * if the --autoplay command line flag was given.
  */
 void vss_init(void)
 {
@@ -212,9 +212,9 @@ static void vss_eof(void)
 /**
  * Get the header of the current audio file.
  *
- * \param header_len the length of the header is stored here
+ * \param header_len The length of the header is stored here.
  *
- * \return a pointer to a buffer containing the header, or NULL, if no audio
+ * \return A pointer to a buffer containing the header, or NULL, if no audio
  * file is selected or if the current audio format does not need special header
  * treamtment.
  *
@@ -228,9 +228,9 @@ char *vss_get_header(size_t *header_len)
 }
 
 /**
- * get the list of all supported audio formats
+ * Get the list of all supported audio formats.
  *
- * \return a space separated list of all supported audio formats
+ * \return Aa space separated list of all supported audio formats
  * It is not allocated at runtime, i.e. there is no need to free
  * the returned string in the caller.
  */
@@ -240,9 +240,9 @@ const char *supported_audio_formats(void)
 }
 
 /**
- * get the chunk time of the current audio file
+ * Get the chunk time of the current audio file.
  *
- * \return a pointer to a struct containing the chunk time, or NULL,
+ * \return A pointer to a struct containing the chunk time, or NULL,
  * if currently no audio file is selected.
  */
 struct timeval *vss_chunk_time(void)
@@ -436,7 +436,7 @@ static void get_chunk(long unsigned chunk_num, char **buf, size_t *len)
  * \param buf Chunk data.
  * \param len Chunk length in bytes.
  *
- * \return Positive on success, negative on errors.
+ * \return Standard.
  */
 int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 {
@@ -449,13 +449,13 @@ int vss_get_chunk(long unsigned chunk_num, char **buf, size_t *len)
 }
 
 /**
- * main sending function
+ * Main sending function.
  *
- * This function gets called from para_server as soon as the next chunk of
- * data should be pushed out. It first calls the read_chunk() function of
- * the current audio format handler to obtain a pointer to the data to be
- * sent out as well as its length. This information is then passed to each
- * supported sender's send() function which does the actual sending.
+ * This function gets called from para_server as soon as the next chunk of data
+ * should be pushed out. It obtains a pointer to the data to be sent out as
+ * well as its length from mmd->afd.afhi. This information is then passed to
+ * each supported sender's send() function which is supposed to send out the data
+ * to all connected clients.
  */
 void vss_send_chunk(void)
 {