[svn-commits] russell: branch murf/bug11210 r99404 - /team/murf/bug11210/channels/chan_sip.c

[SVN commits to the Digium repositories]

Author: russell
Date: Mon Jan 21 15:50:32 2008
New Revision: 99404

URL: http://svn.digium.com/view/asterisk?view=rev&rev=99404
Log:
- Update doxygen comments for a function.
- Add a TODO item for some code that needs to be checked.

Modified:
    team/murf/bug11210/channels/chan_sip.c

Change Statistics:
 team/murf/bug11210/channels/chan_sip.c |   11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Modified: team/murf/bug11210/channels/chan_sip.c
URL: http://svn.digium.com/view/asterisk/team/murf/bug11210/channels/chan_sip.c?view=diff&rev=99404&r1=99403&r2=99404
==============================================================================
--- team/murf/bug11210/channels/chan_sip.c (original)
+++ team/murf/bug11210/channels/chan_sip.c Mon Jan 21 15:50:32 2008
@@ -2370,7 +2370,13 @@
 	return peer;
 }
 
-
+/*!
+ * \brief Unlink a dialog from the dialogs container, as well as any other places
+ * that it may be currently stored.
+ *
+ * \note A reference to the dialog must be held before calling this function, and this
+ * function does not release that reference.
+ */
 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist)
 {
 	ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
@@ -4037,6 +4043,9 @@
  *	again from memory or database during the life time of the dialog.
  *
  * \return -1 on error, 0 on success.
+ *
+ * \todo XXX This function is written in such a way that it expects the dialog to be locked.
+ * Is this actually true?
  */
 static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)
 {