[asterisk-commits] rmudgett: branch rmudgett/bridge_phase r388245 - /team/rmudgett/bridge_phase/...

[SVN commits to the Asterisk project]

Author: rmudgett
Date: Thu May  9 19:43:33 2013
New Revision: 388245

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=388245
Log:
Adjust doxygen comments from review feedback.

Modified:
    team/rmudgett/bridge_phase/include/asterisk/core_local.h
    team/rmudgett/bridge_phase/include/asterisk/core_unreal.h

Modified: team/rmudgett/bridge_phase/include/asterisk/core_local.h
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/include/asterisk/core_local.h?view=diff&rev=388245&r1=388244&r2=388245
==============================================================================
--- team/rmudgett/bridge_phase/include/asterisk/core_local.h (original)
+++ team/rmudgett/bridge_phase/include/asterisk/core_local.h Thu May  9 19:43:33 2013
@@ -48,9 +48,6 @@
  *
  * \note On entry, ast must be locked.
  *
- * \note Intended to be called after ast_request() and before
- * ast_call() on a local channel.
- *
  * \retval peer reffed on success.
  * \retval NULL if no peer or error.
  */
@@ -69,6 +66,9 @@
  * ast_bridge_features_new().  You must not dereference features
  * after calling even if the call fails.
  *
+ * \note Intended to be called after ast_request() and before
+ * ast_call() on a local channel.
+ *
  * \retval 0 on success.
  * \retval -1 on error.
  */
@@ -80,6 +80,9 @@
  *
  * \param ast Either channel of a local channel pair.
  * \param masq Channel to masquerade into.
+ *
+ * \note Intended to be called after ast_request() and before
+ * ast_call() on a local channel.
  *
  * \retval 0 on success.
  * \retval -1 on error.

Modified: team/rmudgett/bridge_phase/include/asterisk/core_unreal.h
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/include/asterisk/core_unreal.h?view=diff&rev=388245&r1=388244&r2=388245
==============================================================================
--- team/rmudgett/bridge_phase/include/asterisk/core_unreal.h (original)
+++ team/rmudgett/bridge_phase/include/asterisk/core_unreal.h Thu May  9 19:43:33 2013
@@ -84,21 +84,45 @@
  * \param p Private channel struct (reffed)
  * \param ast Channel being hung up.  (locked)
  *
+ * \note Common hangup code for unreal channels.  Derived
+ * channels will need to deal with any additional resources.
+ *
  * \retval 0 on success.
  * \retval -1 on error.
  */
 int ast_unreal_hangup(struct ast_unreal_pvt *p, struct ast_channel *ast);
 
+/*! Unreal channel framework struct ast_channel_tech.send_digit_begin callback */
 int ast_unreal_digit_begin(struct ast_channel *ast, char digit);
+
+/*! Unreal channel framework struct ast_channel_tech.send_digit_end callback */
 int ast_unreal_digit_end(struct ast_channel *ast, char digit, unsigned int duration);
+
+/*! Unreal channel framework struct ast_channel_tech.answer callback */
 int ast_unreal_answer(struct ast_channel *ast);
+
+/*! Unreal channel framework struct ast_channel_tech.read and struct ast_channel_tech.exception callback */
 struct ast_frame *ast_unreal_read(struct ast_channel *ast);
+
+/*! Unreal channel framework struct ast_channel_tech.write callback */
 int ast_unreal_write(struct ast_channel *ast, struct ast_frame *f);
+
+/*! Unreal channel framework struct ast_channel_tech.indicate callback */
 int ast_unreal_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
+
+/*! Unreal channel framework struct ast_channel_tech.fixup callback */
 int ast_unreal_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
+
+/*! Unreal channel framework struct ast_channel_tech.send_html callback */
 int ast_unreal_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen);
+
+/*! Unreal channel framework struct ast_channel_tech.send_text callback */
 int ast_unreal_sendtext(struct ast_channel *ast, const char *text);
+
+/*! Unreal channel framework struct ast_channel_tech.queryoption callback */
 int ast_unreal_queryoption(struct ast_channel *ast, int option, void *data, int *datalen);
+
+/*! Unreal channel framework struct ast_channel_tech.setoption callback */
 int ast_unreal_setoption(struct ast_channel *chan, int option, void *data, int datalen);
 
 /*!