Doxygenation of the main Alarm/Event and COV functions.

Also documented the main misc functions for handlers.
This commit is contained in:
tbrennan3
2010-03-12 03:30:31 +00:00
parent bfd3920698
commit 47ff6200f1
9 changed files with 142 additions and 3 deletions
+16
View File
@@ -39,6 +39,22 @@
/** @file h_alarm_ack.c Handles Alarm Acknowledgment. */
/** Handler for an Alarm/Event Acknowledgement.
* @ingroup ALMACK
* This handler will be invoked by apdu_handler() if it has been enabled
* by a call to apdu_set_confirmed_handler().
* This handler builds a response packet, which is
* - an Abort if
* - the message is segmented
* - if decoding fails
* - Otherwise, sends a simple ACK
*
* @param service_request [in] The contents of the service request.
* @param service_len [in] The length of the service_request.
* @param src [in] BACNET_ADDRESS of the source of the message
* @param service_data [in] The BACNET_CONFIRMED_SERVICE_DATA information
* decoded from the APDU header of this message.
*/
void handler_alarm_ack(
uint8_t * service_request,
uint16_t service_len,