[asterisk-commits] russell: trunk r83849 - /trunk/include/asterisk/file.h

[SVN commits to the Asterisk project]

Author: russell
Date: Wed Sep 26 01:31:05 2007
New Revision: 83849

URL: http://svn.digium.com/view/asterisk?view=rev&rev=83849
Log:
Change function documentation to use doxygen tags.  (Really, I just needed
to make some minor change in trunk to test something with automerge ...)

Modified:
    trunk/include/asterisk/file.h

Modified: trunk/include/asterisk/file.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/file.h?view=diff&rev=83849&r1=83848&r2=83849
==============================================================================
--- trunk/include/asterisk/file.h (original)
+++ trunk/include/asterisk/file.h Wed Sep 26 01:31:05 2007
@@ -266,8 +266,11 @@
  */
 int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms);
 
-/* Same as waitstream, but with audio output to fd and monitored fd checking.  Returns
-   1 if monfd is ready for reading */
+/*!
+ * Same as waitstream, but with audio output to fd and monitored fd checking.  
+ *
+ * \return 1 if monfd is ready for reading 
+ */
 int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd);
 
 /*!