doxify acl.c.
[paraslash.git] / chunk_queue.c
index 17d70ea..61dd382 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
  * allows them to enqueue chunks if they can not be sent out immediately.
  *
  * Chunk queues are "cheap" in the sense that only reference to the audio file
- * data is stored, but not the data itsself.
+ * data is stored, but not the data itself.
  */
 struct chunk_queue {
        /** The list of pending chunks for this client. */
        struct list_head q;
        /** The number of pending bytes for this client. */
        unsigned long num_pending;
-       /** Enqueueing more than that many bytes is an error. */
+       /** More than that many bytes in the queue is considered an error. */
        unsigned long max_pending;
 };
 
@@ -79,7 +79,7 @@ int cq_enqueue(struct chunk_queue *cq, long unsigned chunk_num,
  *
  * \param cq The chunk queue.
  *
- * \return The next queued chunk, or \p NULL if there is no chunk awailable.
+ * \return The next queued chunk, or \p NULL if there is no chunk available.
  */
 struct queued_chunk *cq_peek(struct chunk_queue *cq)
 {
@@ -102,7 +102,7 @@ void cq_dequeue(struct chunk_queue *cq)
 }
 
 /**
- * Change the number of bytes send for the current queued chunk.
+ * Change the number of bytes sent for the current queued chunk.
  *
  * \param cq The chunk queue.
  * \param sent Number of bytes successfully sent.