aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/Host/Incomplete/BluetoothHost/Lib
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2012-02-01 21:28:25 +0000
committerDean Camera <dean@fourwalledcubicle.com>2012-02-01 21:28:25 +0000
commitfc4d3ab4003743718d0849d3c963d1fa55c4954f (patch)
tree72a8811e57bbfb7c0f83c2fab60154b77ae7ad22 /Demos/Host/Incomplete/BluetoothHost/Lib
parent956f9e3709ff56acf37f2f446668b6d1411154f4 (diff)
downloadlufa-fc4d3ab4003743718d0849d3c963d1fa55c4954f.tar.gz
lufa-fc4d3ab4003743718d0849d3c963d1fa55c4954f.tar.bz2
lufa-fc4d3ab4003743718d0849d3c963d1fa55c4954f.zip
Minor documentation improvements.
Diffstat (limited to 'Demos/Host/Incomplete/BluetoothHost/Lib')
-rw-r--r--Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c2
-rw-r--r--Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h16
-rw-r--r--Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h2
-rw-r--r--Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h2
4 files changed, 11 insertions, 11 deletions
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
index ed5db0005..e721889a7 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
@@ -207,7 +207,7 @@ static void Bluetooth_ProcessIncomingACLPackets(void)
/** Retrieves the channel information structure with the given local or remote channel number from the channel list.
*
* \param[in] SearchValue Value to search for in the channel structure list
- * \param[in] SearchKey Key to search within the channel structure, a CHANNEL_SEARCH_* mask
+ * \param[in] SearchKey Key to search within the channel structure, a \c CHANNEL_SEARCH_* mask
*
* \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise
*/
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
index 953a5a14a..7e5b11f74 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h
@@ -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;
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
index 8e515a5d4..ed7a7a738 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h
@@ -121,7 +121,7 @@
/** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
typedef struct
{
- uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */
+ uint32_t Class; /**< Class of the local device, a mask of \c 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. */
} Bluetooth_Device_t;
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h b/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
index 695aac733..d9ab87177 100644
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h
@@ -99,7 +99,7 @@
*/
typedef struct
{
- uint8_t PDU; /**< SDP packet type, a SDP_PDU_* mask value */
+ uint8_t PDU; /**< SDP packet type, a \c SDP_PDU_* mask value */
uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */
uint16_t ParameterLength; /**< Length of the data following the SDP header */
} SDP_PDUHeader_t;