Doxygenation of the main Alarm/Event and COV functions.

Also documented the main misc functions for handlers.
2010-03-12 03:30:31 +00:00
parent bfd3920698
commit 47ff6200f1
9 changed files with 142 additions and 3 deletions
@@ -36,7 +36,14 @@

 /** @file s_cevent.c  Send a ConfirmedEventNotification Request. */

-/* returns the invoke id, 0=unsuccessful */
+/** Sends an Confirmed Alarm/Event Notification.
+ * @ingroup EVNOTFCN
+ *  
+ * @param device_id [in] ID of the destination device
+ * @param data [in] The information about the Event to be sent.
+ * @return invoke id of outgoing message, or 0 if communication is disabled,
+ *         or no tsm slot is available. 
+ */
 uint8_t Send_CEvent_Notify(
    uint32_t device_id,
    BACNET_EVENT_NOTIFICATION_DATA * data)