[asterisk-commits] russell: trunk r410639 - /trunk/include/asterisk/framehook.h

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Sat Mar 15 10:24:35 CDT 2014


Author: russell
Date: Sat Mar 15 10:24:23 2014
New Revision: 410639

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=410639
Log:
framehook.h: Fix some doc typos.

There were a number of instances in this header file where "function all" was
intended to be "function call".  This patch fixes that up.

Modified:
    trunk/include/asterisk/framehook.h

Modified: trunk/include/asterisk/framehook.h
URL: http://svnview.digium.com/svn/asterisk/trunk/include/asterisk/framehook.h?view=diff&rev=410639&r1=410638&r2=410639
==============================================================================
--- trunk/include/asterisk/framehook.h (original)
+++ trunk/include/asterisk/framehook.h Sat Mar 15 10:24:23 2014
@@ -222,7 +222,7 @@
  * \param chan ast_channel The channel to attach the hook on to.
  * \param i framehook interface, The framehook's callback functions and stored data.
  *
- * \pre The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function call.
  *
  * \note The data pointer is never touched by the framehook API except to
  * provide it during the event and destruction callbacks.  It is entirely up to the
@@ -237,7 +237,7 @@
  * \brief Detach an framehook from a channel.
  * \since 1.8
  * 
- * \pre The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function call.
  * If this function is never called after attaching an framehook,
  * the framehook will be detached and destroyed during channel
  * destruction.
@@ -256,7 +256,7 @@
  * framehooks on a channel during channel destruction.
  * \since 1.8
  *
- * \pre The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function call.
  * 
  * \param chan channel containing the framehook list to destroy.
  * \retval 0 success
@@ -272,7 +272,7 @@
  * even NULL.  There is nothing to keep up with after this function. If the frame is modified, the
  * framehook callback is in charge of any memory management associated with that modification.
  *
- * \pre The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function call.
  *
  * \param framehooks list to push event to.
  * \param frame being pushed to the framehook list.
@@ -289,7 +289,7 @@
  * even NULL.  There is nothing to keep up with after this function. If the frame is modified, the
  * framehook callback is in charge of any memory management associated with that modification.
  *
- * \pre The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function call.
  *
  * \param framehooks list to push event to.
  * \param frame being pushed to the framehook list.
@@ -301,7 +301,7 @@
 /*!
  * \brief Determine if an framehook list is empty or not
  * \since 1.8
- * \pre The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function call.
  *
  * \param framehooks the framehook list
  * \retval 0, not empty
@@ -312,7 +312,7 @@
 /*!
  * \brief Determine if a framehook list is free of active framehooks or not
  * \since 12.0.0
- * \pre The channel must be locked during this function all.
+ * \pre The channel must be locked during this function call.
  *
  * \param framehooks the framehook list
  * \retval 0, not empty




More information about the asterisk-commits mailing list