Various small cleanups and documentation improvements.
[paraslash.git] / vss.c
diff --git a/vss.c b/vss.c
index 1bd74de..c118970 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -65,15 +65,25 @@ enum afs_socket_status {
 
 /** The task structure for the virtual streaming system. */
 struct vss_task {
+       /** Copied from the -announce_time command line option. */
        struct timeval announce_tv;
+       /** End of the announcing interval. */
        struct timeval data_send_barrier;
+       /** End of the EOF interval. */
        struct timeval eof_barrier;
+       /** Only used if --autoplay_delay was given. */
        struct timeval autoplay_barrier;
+       /** Used for afs-server communication. */
        int afs_socket;
+       /** The current state of \a afs_socket. */
        enum afs_socket_status afsss;
+       /** The memory mapped audio file. */
        char *map;
+       /** Used by the scheduler. */
        struct task task;
+       /** Pointer to the header of the mapped audio file. */
        const char *header_buf;
+       /** Length of the audio file header. */
        size_t header_len;
 };