Merged revisions 184344 via svnmerge from

https://origsvn.digium.com/svn/asterisk/trunk

........
r184344 | russell | 2009-03-25 17:11:35 -0500 (Wed, 25 Mar 2009) | 2 lines

Remove unneeded AST_LIST_ENTRY() and comment on the purpose of ast_event_ref.

........


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.6.2@184346 65c4cc65-6c06-0410-ace0-fbb531ad65f3

main/event.c

@@ -86,9 +86,18 @@ struct ast_event {
 	unsigned char payload[0];
 } __attribute__((packed));
 
+
+/*!
+ * \brief A holder for an event
+ *
+ * \details This struct used to have more of a purpose than it does now.
+ * It is used to hold events in the event cache.  It can be completely removed
+ * if one of these two things is done:
+ *  - ast_event gets changed such that it never has to be realloc()d
+ *  - astobj2 is updated so that you can realloc() an astobj2 object
+ */
 struct ast_event_ref {
 	struct ast_event *event;
-	AST_LIST_ENTRY(ast_event_ref) entry;
 };
 
 struct ast_event_ie_val {