[svn-commits] russell: branch russell/event_performance r184319 - /team/russell/event_perfo...

[SVN commits to the Digium repositories]

Author: russell
Date: Wed Mar 25 15:30:42 2009
New Revision: 184319

URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=184319
Log:
Move documentation down to function implementation

Modified:
    team/russell/event_performance/main/event.c

Modified: team/russell/event_performance/main/event.c
URL: http://svn.digium.com/svn-view/asterisk/team/russell/event_performance/main/event.c?view=diff&rev=184319&r1=184318&r2=184319
==============================================================================
--- team/russell/event_performance/main/event.c (original)
+++ team/russell/event_performance/main/event.c Wed Mar 25 15:30:42 2009
@@ -122,57 +122,9 @@
  * The event subscribers are indexed by which event they are subscribed to */
 static AST_RWDLLIST_HEAD(ast_event_sub_list, ast_event_sub) ast_event_subs[AST_EVENT_TOTAL];
 
-/*!
- * \internal
- * \brief Compare two events
- *
- * \param[in] obj the first event, as an ast_event_ref
- * \param[in] arg the second event, as an ast_event_ref
- * \param[in] flags unused
- *
- * \pre Both events must be the same type.
- * \pre The event type must be declared as a cached event type in ast_event_cache
- *
- * \details This function takes two events, and determines if they are considered
- * equivalent.  The values of information elements specified in the cache arguments
- * for the event type are used to determine if the events are equivalent.
- *
- * \retval 0 No match
- * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
- */
 static int ast_event_cmp(void *obj, void *arg, int flags);
-
-/*!
- * \internal
- * \brief Hash function for AST_EVENT_MWI
- *
- * \param[in] obj an ast_event
- * \param[in] flags unused
- *
- * \return hash value
- */
 static int ast_event_hash_mwi(const void *obj, const int flags);
-
-/*!
- * \internal
- * \brief Hash function for AST_EVENT_DEVICE_STATE
- *
- * \param[in] obj an ast_event
- * \param[in] flags unused
- *
- * \return hash value
- */
 static int ast_event_hash_devstate(const void *obj, const int flags);
-
-/*!
- * \internal
- * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
- *
- * \param[in] obj an ast_event
- * \param[in] flags unused
- *
- * \return hash value
- */
 static int ast_event_hash_devstate_change(const void *obj, const int flags);
 
 #ifdef LOW_MEMORY
@@ -1225,6 +1177,15 @@
 	return ast_str_hash_add(context, ast_str_hash(mailbox));
 }
 
+/*!
+ * \internal
+ * \brief Hash function for AST_EVENT_DEVICE_STATE
+ *
+ * \param[in] obj an ast_event
+ * \param[in] flags unused
+ *
+ * \return hash value
+ */
 static int ast_event_hash_devstate(const void *obj, const int flags)
 {
 	const struct ast_event *event = obj;
@@ -1232,6 +1193,15 @@
 	return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
 }
 
+/*!
+ * \internal
+ * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
+ *
+ * \param[in] obj an ast_event
+ * \param[in] flags unused
+ *
+ * \return hash value
+ */
 static int ast_event_hash_devstate_change(const void *obj, const int flags)
 {
 	const struct ast_event *event = obj;
@@ -1255,6 +1225,24 @@
 	return hash_fn(event, flags);
 }
 
+/*!
+ * \internal
+ * \brief Compare two events
+ *
+ * \param[in] obj the first event, as an ast_event_ref
+ * \param[in] arg the second event, as an ast_event_ref
+ * \param[in] flags unused
+ *
+ * \pre Both events must be the same type.
+ * \pre The event type must be declared as a cached event type in ast_event_cache
+ *
+ * \details This function takes two events, and determines if they are considered
+ * equivalent.  The values of information elements specified in the cache arguments
+ * for the event type are used to determine if the events are equivalent.
+ *
+ * \retval 0 No match
+ * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
+ */
 static int ast_event_cmp(void *obj, void *arg, int flags)
 {
 	struct ast_event_ref *event_ref, *event_ref2;