[svn-commits] russell: branch group/newcdr r202150 - in /team/group/newcdr: include/asteris...

[SVN commits to the Digium repositories]

Author: russell
Date: Sat Jun 20 10:35:21 2009
New Revision: 202150

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=202150
Log:
Fill out docs for fabricate_channel() and leave a note that it is evil and needs to die at some point

Modified:
    team/group/newcdr/include/asterisk/cel.h
    team/group/newcdr/main/cel.c

Modified: team/group/newcdr/include/asterisk/cel.h
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/newcdr/include/asterisk/cel.h?view=diff&rev=202150&r1=202149&r2=202150
==============================================================================
--- team/group/newcdr/include/asterisk/cel.h (original)
+++ team/group/newcdr/include/asterisk/cel.h Sat Jun 20 10:35:21 2009
@@ -163,8 +163,20 @@
  */
 void ast_cel_check_retire_linkedid(const struct ast_channel *chan);
 
-/*! Create a fake channel containing the serialized channel date in
- the given cel event.  Must be released with ast_channel_release */
+/*!
+ * \brief Create a fake channel from data in a CEL event
+ *
+ * This function creates a fake channel containing the serialized channel data 
+ * in the given cel event.  It must be released with ast_channel_release.
+ *
+ * \param event the CEL event
+ *
+ * \return a channel with the data filled in, or NULL on error
+ *
+ * \todo This function is \b very expensive, especially given that some CEL backends
+ *       use it on \b every CEL event.  This function really needs to go away at
+ *       some point.
+ */
 struct ast_channel *ast_cel_fabricate_channel_from_event(const struct ast_event *event);
 
 void ast_cel_report_event(const struct ast_channel *chan, enum ast_cel_event_type,

Modified: team/group/newcdr/main/cel.c
URL: http://svn.asterisk.org/svn-view/asterisk/team/group/newcdr/main/cel.c?view=diff&rev=202150&r1=202149&r2=202150
==============================================================================
--- team/group/newcdr/main/cel.c (original)
+++ team/group/newcdr/main/cel.c Sat Jun 20 10:35:21 2009
@@ -367,9 +367,6 @@
 	}
 }
 
-/* this routine is only called to populate a dummy channel struct with the data,
-   so the CEL func can grab the correct datum and have it substituted, the same as if
-   a real channel were being used with the CEL func. What we do for re-use!! */
 struct ast_channel *ast_cel_fabricate_channel_from_event(const struct ast_event *event)
 {
 	enum ast_cel_event_type event_type;