[asterisk-commits] oej: trunk r284217 - /trunk/include/asterisk/say.h

[SVN commits to the Asterisk project]

Author: oej
Date: Mon Aug 30 03:25:50 2010
New Revision: 284217

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=284217
Log:
Doxygen formatting

You can't write "same as above" in hypertext documentation. Above doesn't make sense in
hyperspace.

Modified:
    trunk/include/asterisk/say.h

Modified: trunk/include/asterisk/say.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/say.h?view=diff&rev=284217&r1=284216&r2=284217
==============================================================================
--- trunk/include/asterisk/say.h (original)
+++ trunk/include/asterisk/say.h Mon Aug 30 03:25:50 2010
@@ -82,7 +82,7 @@
 int ast_say_number(struct ast_channel *chan, int num,
 	const char *ints, const char *lang, const char *options);
 
-/* Same as above with audiofd for received audio and returns 1 on ctrlfd being readable */
+/*! \brief Same as \ref ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable */
 SAY_EXTERN int (* ast_say_number_full)(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_number_full);
 
 /*!
@@ -102,6 +102,7 @@
 int ast_say_enumeration(struct ast_channel *chan, int num,
 	const char *ints, const char *lang, const char *options);
 
+/*! \brief Same as \ref ast_say_enumeration() with audiofd for received audio and returns 1 on ctrlfd being readable */
 SAY_EXTERN int (* ast_say_enumeration_full)(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_enumeration_full);
 
 /*!
@@ -119,6 +120,7 @@
 int ast_say_digits(struct ast_channel *chan, int num,
 	const char *ints, const char *lang);
 
+/*! \brief Same as \ref ast_say_digits() with audiofd for received audio and returns 1 on ctrlfd being readable */
 int ast_say_digits_full(struct ast_channel *chan, int num,
 	const char *ints, const char *lang, int audiofd, int ctrlfd);
 
@@ -137,16 +139,17 @@
 int ast_say_digit_str(struct ast_channel *chan, const char *num,
 	const char *ints, const char *lang);
 
+/*! \brief Same as \ref ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable */
 SAY_EXTERN int (* ast_say_digit_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_digit_str_full);
 
-/*
+/*! \brief
  * the generic 'say' routine, with the first chars in the string
  * defining the format to use
  */
 SAY_EXTERN int (* ast_say_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_full);
 
-/*
- * other function to pronounce character and phonetic strings
+/*! \brief
+ * function to pronounce character and phonetic strings
  */
 int ast_say_character_str(struct ast_channel *chan, const char *num,
 	const char *ints, const char *lang);