[vlc-commits] block: doxify block_FifoNew() and block_FifoRelease()

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Tue Feb 24 22:43:26 2015 +0200| [b68878ff7d986b809b4690d0246b5f6a5eead031] | committer: Rémi Denis-Courmont

block: doxify block_FifoNew() and block_FifoRelease()

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=b68878ff7d986b809b4690d0246b5f6a5eead031
---

 src/misc/block.c |    9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/misc/block.c b/src/misc/block.c
index 0a408cc..a5c4b40 100644
--- a/src/misc/block.c
+++ b/src/misc/block.c
@@ -522,6 +522,11 @@ struct block_fifo_t
     bool          b_force_wake;
 };
 
+/**
+ * Creates a thread-safe FIFO queue of blocks.
+ * See also block_FifoPut() and block_FifoGet().
+ * @return the FIFO or NULL on memory error
+ */
 block_fifo_t *block_FifoNew( void )
 {
     block_fifo_t *p_fifo = malloc( sizeof( block_fifo_t ) );
@@ -539,6 +544,10 @@ block_fifo_t *block_FifoNew( void )
     return p_fifo;
 }
 
+/**
+ * Destroys a FIFO created by block_FifoNew().
+ * Any queued blocks are also destroyed.
+ */
 void block_FifoRelease( block_fifo_t *p_fifo )
 {
     block_FifoEmpty( p_fifo );