Tweaked the comments for better Doxygen output.

This commit is contained in:
tbrennan3
2010-10-13 19:00:57 +00:00
parent 48411b8dbf
commit a5f24fa19f
8 changed files with 53 additions and 12 deletions
+4 -2
View File
@@ -297,8 +297,8 @@ static void Init_Service_Handlers(
* We also limit the output to 4 bit fields per line.
*
* @param stream [in] Normally stdout
* @param value [in] The structure holding this property's value (union) and type.
* @param property [in] Which property we are printing.
* @param object_value [in] The structure holding this property's description
* and value.
* @return True if success. Or otherwise.
*/
@@ -375,6 +375,8 @@ bool PrettyPrintPropertyValue(
* through a list (Using_Walked_List is True) to show just one value of the
* array per call.
*
* @param object_type [in] The BACnet Object type of this object.
* @param object_instance [in] The ID number for this object.
* @param rpm_property [in] Points to structure holding the Property,
* Value, and Error information.
*/
+1
View File
@@ -46,6 +46,7 @@
* and passing the remaining bytes to the apdu_handler.
* @note The routing (except src) and NCPI information, including
* npdu_data->data_expecting_reply, are discarded.
* @ingroup MISCHNDLR
*
* @param src [out] Returned with routing source information if the NPDU
* has any and if this points to non-null storage for it.
+5 -3
View File
@@ -231,11 +231,13 @@ static void routed_apdu_handler(
* - Decoding of the NCPI byte
* - Further processing by network_control_handler() if this is a network
* layer message.
* - Further processing if it contains an APDU
* - Further processing by routed_apdu_handler() if it contains an APDU
* - Normally (no routing) by apdu_handler()
* - With Routing (a further destination was indicated) by
* - With Routing (a further destination was indicated) by the decoded
* destination.
* - Errors in decoding.
* @note The npdu_data->data_expecting_reply status is discarded.
* @note The npdu_data->data_expecting_reply status is discarded.
* @ingroup NMRC
*
* @param src [out] Returned with routing source information if the NPDU
* has any and if this points to non-null storage for it.
+6
View File
@@ -229,6 +229,7 @@ int Send_Network_Layer_Message(
/** Finds a specific router, or all reachable BACnet networks.
* The response(s) will come in I-am-router-to-network message(s).
* @ingroup NMRC
*
* @param dst [in] If NULL, request will be broadcast to the local BACnet
* network. Optionally may designate a particular router
@@ -249,6 +250,8 @@ void Send_Who_Is_Router_To_Network(
* we can reach.
* The message will be sent to our normal DataLink Layer interface,
* not the routed backend.
* @ingroup NMRC
*
* @param DNET_list [in] List of BACnet network numbers for which I am a router,
* terminated with -1
*/
@@ -262,6 +265,7 @@ void Send_I_Am_Router_To_Network(
/** Finds a specific router, or all reachable BACnet networks.
* The response(s) will come in I-am-router-to-network message(s).
* @ingroup NMRC
*
* @param dst [in] If NULL, request will be broadcast to the local BACnet
* network. Otherwise, designates a particular router
@@ -290,6 +294,7 @@ void Send_Reject_Message_To_Network(
* In that case, DNET[] should just have one entry of -1 (no routing table
* is sent).
* 2) We are sending out our Routing Table for some reason (normally bcast it).
* @ingroup NMRC
*
* @param dst [in] If NULL, msg will be broadcast to the local BACnet network.
* Optionally may designate a particular router destination,
@@ -316,6 +321,7 @@ void Send_Initialize_Routing_Table(
* routing table, and then we will want to respond to that dst router.
* In that case, DNET[] should just have one entry of -1 (no routing table
* is sent).
* @ingroup NMRC
*
* @param dst [in] If NULL, Ack will be broadcast to the local BACnet network.
* Optionally may designate a particular router destination,
+1 -1
View File
@@ -21,7 +21,7 @@
*---------------------------------------------------------------------
*/
/** @file gw_device.c [Description of this file]. */
/** @file gw_device.c Functions that extend the Device object to support routing. */
#include <stdbool.h>
#include <stdint.h>