michi/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor documentation improvements.

Browse Source
This commit is contained in:
Dean Camera
2012-02-01 21:28:25 +00:00
parent 956f9e3709
commit fc4d3ab400
20 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
+8 -8
View File
@@ -108,7 +108,7 @@
/** Bluetooth signaling command header structure, for all ACL packets containing a signaling command. */
typedef struct
{
uint8_t Code; /**< Signal code, a BT_SIGNAL_* mask value */
uint8_t Code; /**< Signal code, a \c BT_SIGNAL_* mask value */
uint8_t Identifier; /**< Unique signal command identifier to link requests and responses */
uint16_t Length; /**< Length of the signaling command data, in bytes */
} BT_Signal_Header_t;
@@ -116,7 +116,7 @@
/** Connection Request signaling command structure, for channel connection requests. */
typedef struct
{
uint16_t PSM; /**< Type of data the channel will carry, a CHANNEL_PSM_* mask value */
uint16_t PSM; /**< Type of data the channel will carry, a \c CHANNEL_PSM_* mask value */
uint16_t SourceChannel; /**< Channel source on the sending device this channel will link to */
} BT_Signal_ConnectionReq_t;
@@ -125,7 +125,7 @@
{
uint16_t DestinationChannel; /**< Destination device channel that the connection request was processed on */
uint16_t SourceChannel; /**< Source device channel address that the connection request came from */
uint16_t Result; /**< Connection result, a BT_CONNECTION_* mask value */
uint16_t Result; /**< Connection result, a \c BT_CONNECTION_* mask value */
uint16_t Status; /**< Status of the request if the result was set to the Pending value */
} BT_Signal_ConnectionResp_t;
@@ -155,20 +155,20 @@
{
uint16_t SourceChannel; /**< Source channel that the configuration request was directed at */
uint16_t Flags; /**< Configuration flags for the response, including response continuation */
uint16_t Result; /**< Configuration result, a BT_CONFIGURATION_* mask value */
uint16_t Result; /**< Configuration result, a \c BT_CONFIGURATION_* mask value */
} BT_Signal_ConfigurationResp_t;
/** Information Request signaling command structure, for device information requests. */
typedef struct
{
uint16_t InfoType; /**< Data type that is being requested, a BT_INFOREQ_* mask value */
uint16_t InfoType; /**< Data type that is being requested, a \c BT_INFOREQ_* mask value */
} BT_Signal_InformationReq_t;
/** Information Response signaling command structure, for responses to information requests. */
typedef struct
{
uint16_t InfoType; /**< Data type that was requested, a BT_INFOREQ_* mask value */
uint16_t Result; /**< Result of the request, a BT_INFORMATION_* mask value */
uint16_t InfoType; /**< Data type that was requested, a \c BT_INFOREQ_* mask value */
uint16_t Result; /**< Result of the request, a \c BT_INFORMATION_* mask value */
} BT_Signal_InformationResp_t;
/** Configuration Option header structure, placed at the start of each option in a Channel Configuration
@@ -176,7 +176,7 @@
*/
typedef struct
{
uint8_t Type; /**< Option type, a BT_CONFIG_OPTION_* mask value */
uint8_t Type; /**< Option type, a \c BT_CONFIG_OPTION_* mask value */
uint8_t Length; /**< Length of the option's value, in bytes */
} BT_Config_Option_Header_t;