X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/e0ef5741d49dc5b36f3bb8165506b51006e68ee3..96063b9f98c8201623f8c91ec5cbe3bb88aca6c3:/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h?ds=sidebyside

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
index 4b16a8f48..060f4fffd 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
@@ -63,7 +63,7 @@
 		#define MAXIMUM_CHANNEL_MTU            255
 		
 	/* Enums: */
-		/** Enum for the possible states for a bluetooth ACL channel. */
+		/** Enum for the possible states for a Bluetooth ACL channel. */
 		enum BT_ChannelStates_t
 		{
 			Channel_Closed                = 0, /**< Channel is closed and inactive. No data may be sent or received. */
@@ -85,7 +85,7 @@
 		enum BT_SendPacket_ErrorCodes_t
 		{
 			BT_SENDPACKET_NoError            = 0, /**< The packet was sent sucessfully. */
-			BT_SENDPACKET_NotConnected       = 1, /**< The bluetooth stack is not currently connected to a remote device. */
+			BT_SENDPACKET_NotConnected       = 1, /**< The Bluetooth stack is not currently connected to a remote device. */
 			BT_SENDPACKET_ChannelNotOpen     = 2, /**< The given channel is not currently in the Open state. */
 		};
 
@@ -95,12 +95,12 @@
 		 */
 		typedef struct
 		{
-			uint8_t  State;
-			uint16_t LocalNumber;
-			uint16_t RemoteNumber;
-			uint16_t PSM;
-			uint16_t LocalMTU;
-			uint16_t RemoteMTU;
+			uint8_t  State; /**< Current channel state, a value from the \ref BT_ChannelStates_t enum. */
+			uint16_t LocalNumber; /**< Local channel number on the device. */
+			uint16_t RemoteNumber; /**< Remote channel number on the connected device. */
+			uint16_t PSM; /**< Protocol used on the channel. */
+			uint16_t LocalMTU; /**< MTU of data sent from the connected device to the local device. */
+			uint16_t RemoteMTU; /**< MTU of data sent from the local device to the connected device. */
 		} Bluetooth_Channel_t;
 
 		/** Type define for a Bluetooth device connection information structure. This structure contains all the
@@ -122,7 +122,7 @@
 		{
 			uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */
 			char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
-			char     Name[]; /**< Name of the local bluetooth device, up to 248 characters. */
+			char     Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */
 		} Bluetooth_Device_t;
 		
 		/** Bluetooth stack state information structure, for the containment of the Bluetooth stack state. The values in
@@ -136,7 +136,7 @@
 			bool    IsInitialized; /**< Indicates if the Bluetooth stack is currently initialized and ready for connections
 			                        *   to or from a remote Bluetooth device.
 			                        */
-			uint8_t LocalBDADDR[6]; /**< Local bluetooth adapter's BDADDR, valid when the stack is fully initialized. */
+			uint8_t LocalBDADDR[6]; /**< Local Bluetooth adapter's BDADDR, valid when the stack is fully initialized. */
 		} Bluetooth_Stack_State_t;
 	
 	/* Includes: */