Sensinode / nsdl_lib

NSDL C library

Dependents:   NSDL_HelloWorld_WiFi UbloxModemNanoServiceClient IOT-NSDL_HelloWorld LWM2M_NanoService_Ethernet ... more

Fork of nsdl_lib by Tero Heinonen

Note that use of this software requires acceptance of the Sensinode EULA: http://mbed.org/teams/Sensinode/code/nsdl_lib/wiki/EULA

Diff: sn_nsdl.h

Revision:
3:d8cb1afd7285
Parent:
1:01d723824294
Child:
4:0f845ba8adff
diff -r ab50a2ab6ec9 -r d8cb1afd7285 sn_nsdl.h
--- a/sn_nsdl.h	Wed Oct 09 14:57:33 2013 +0000
+++ b/sn_nsdl.h	Thu Oct 10 10:24:59 2013 +0000
@@ -69,7 +69,7 @@
 /* * * * * * * * * * * * * */
 
 /**
- * Address structure of Packet data
+ * \brief Address structure of Packet data
  */
 typedef struct sn_nsdl_addr_
 {
@@ -85,7 +85,7 @@
 } sn_nsdl_addr_s;
 
 /**
- * This structure is returned by sn_coap_exec() for sending
+ * \brief This structure is returned by sn_coap_exec() for sending
  */
 typedef struct sn_nsdl_transmit_
 {
@@ -97,15 +97,18 @@
     uint8_t                *packet_ptr;
 } sn_nsdl_transmit_s;
 
+/**
+ * \brief Used for creating manually nsdl registration message with sn_coap_register()
+ */
 typedef struct registration_info_
 {
-	uint8_t *endpoint_ptr;
+	uint8_t *endpoint_ptr;			/**< Endpoint name */
 	uint8_t endpoint_len;
 
-	uint8_t *endpoint_type_ptr;
+	uint8_t *endpoint_type_ptr;		/**< Endpoint type */
 	uint8_t endpoint_type_len;
 
-	uint8_t *links_ptr;
+	uint8_t *links_ptr;				/**< Resource registration string */
 	uint16_t links_len;
 
 }registration_info_t;