ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation improvements.

Browse source
This commit is contained in:
Dean Camera 2010-04-15 14:22:06 +00:00
parent 3eb81df998
commit 1f682ca2de
13 changed files with 76 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Demos/Host/Incomplete/BluetoothHost/BluetoothHost.c
View file

@ -199,7 +199,7 @@ void Bluetooth_Host_Task(void)
/** Bluetooth stack callback event for a Bluetooth connection request. When this callback fires, the
* user application must indicate if the connection is to be allowed or rejected.
*
* \param RemoteAddress Bluetooth address of the remote device attempting the connection
* \param[in] RemoteAddress Bluetooth address of the remote device attempting the connection
*
* \return Boolean true to accept the connection, false to reject it
*/
@ -241,9 +241,9 @@ void Bluetooth_DisconnectionComplete(void)
/** Bluetooth stack callback event for a non-signal ACL packet reception. This callback fires once a connection
* to a remote Bluetooth device has been made, and the remote device has sent a non-signalling ACL packet.
*
* \param Data Pointer to a buffer where the received data is stored
* \param DataLen Length of the packet data, in bytes
* \param Channel Bluetooth ACL data channel information structure for the packet's destination channel
* \param[in] Data Pointer to a buffer where the received data is stored
* \param[in] DataLen Length of the packet data, in bytes
* \param[in] Channel Bluetooth ACL data channel information structure for the packet's destination channel
*/
void Bluetooth_PacketReceived(void* Data, uint16_t DataLen, Bluetooth_Channel_t* Channel)
{

28
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
View file

@ -193,10 +193,10 @@ static void Bluetooth_ProcessIncommingACLPackets(void)
/** Sends a packet to the remote device on the specified channel.
*
* \param Data Pointer to a buffer where the data is to be sourced from
* \param DataLen Length of the data to send
* \param Channel Channel information structure containing the destination channel's information, NULL to send
* to the remote device's signalling channel
* \param[in] Data Pointer to a buffer where the data is to be sourced from
* \param[in] DataLen Length of the data to send
* \param[in] Channel Channel information structure containing the destination channel's information, NULL to send
* to the remote device's signalling channel
*
* \return A value from the \ref BT_SendPacket_ErrorCodes_t enum
*/
@ -247,7 +247,7 @@ uint8_t Bluetooth_SendPacket(void* Data, uint16_t DataLen, Bluetooth_Channel_t*
* repeatedly called. The returned channel is unusable by the user application until its State
* element has progressed to the Open state.
*
* \param PSM PSM of the service that the channel is to be opened for
* \param[in] PSM PSM of the service that the channel is to be opened for
*
* \return Pointer to the channel information structure of the opened channel, or NULL if no free channels
*/
@ -311,7 +311,7 @@ Bluetooth_Channel_t* Bluetooth_OpenChannel(uint16_t PSM)
* returned channel is unusable by the user application upon return however the channel is not completely
* closed until its State element has progressed to the Closed state.
*
* \param Channel Channel information structure of the channel to close
* \param[in,out] Channel Channel information structure of the channel to close
*/
void Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel)
{
@ -346,7 +346,7 @@ void Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel)
/** Internal Bluetooth stack Signal Command processing routine for a Connection Request command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_ConnectionReq(BT_Signal_Header_t* SignalCommandHeader)
{
@ -419,7 +419,7 @@ static inline void Bluetooth_Signal_ConnectionReq(BT_Signal_Header_t* SignalComm
/** Internal Bluetooth stack Signal Command processing routine for a Connection Response command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_ConnectionResp(BT_Signal_Header_t* SignalCommandHeader)
{
@ -450,7 +450,7 @@ static inline void Bluetooth_Signal_ConnectionResp(BT_Signal_Header_t* SignalCom
/** Internal Bluetooth stack Signal Command processing routine for a Configuration Request command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_ConfigurationReq(BT_Signal_Header_t* SignalCommandHeader)
{
@ -537,7 +537,7 @@ static inline void Bluetooth_Signal_ConfigurationReq(BT_Signal_Header_t* SignalC
/** Internal Bluetooth stack Signal Command processing routine for a Configuration Response command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_ConfigurationResp(BT_Signal_Header_t* SignalCommandHeader)
{
@ -581,7 +581,7 @@ static inline void Bluetooth_Signal_ConfigurationResp(BT_Signal_Header_t* Signal
/** Internal Bluetooth stack Signal Command processing routine for a Disconnection Request command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_DisconnectionReq(BT_Signal_Header_t* SignalCommandHeader)
{
@ -627,7 +627,7 @@ static inline void Bluetooth_Signal_DisconnectionReq(BT_Signal_Header_t* SignalC
/** Internal Bluetooth stack Signal Command processing routine for a Disconnection Response command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_DisconnectionResp(BT_Signal_Header_t* SignalCommandHeader)
{
@ -652,7 +652,7 @@ static inline void Bluetooth_Signal_DisconnectionResp(BT_Signal_Header_t* Signal
/** Internal Bluetooth stack Signal Command processing routine for an Echo Request command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_EchoReq(BT_Signal_Header_t* SignalCommandHeader)
{
@ -678,7 +678,7 @@ static inline void Bluetooth_Signal_EchoReq(BT_Signal_Header_t* SignalCommandHea
/** Internal Bluetooth stack Signal Command processing routine for an Information Request command.
*
* \param SignalCommandHeader Pointer to the start of the received packet's Signal Command header
* \param[in] SignalCommandHeader Pointer to the start of the received packet's Signal Command header
*/
static inline void Bluetooth_Signal_InformationReq(BT_Signal_Header_t* SignalCommandHeader)
{

6
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothHCICommands.c
View file

@ -311,9 +311,9 @@ void Bluetooth_HCITask(void)
/** Sends a Bluetooth HCI control command to the attached Bluetooth device.
*
* \param HCICommandHeader HCI command header to send to the attached device
* \param Parameters Pointer to the source of the control parameters (if any)
* \param ParameterLength Length of the parameters to send in bytes
* \param[in] HCICommandHeader HCI command header to send to the attached device
* \param[in] Parameters Pointer to the source of the control parameters (if any)
* \param[in] ParameterLength Length of the parameters to send in bytes
*
* \return A value from the USB_Host_SendControlErrorCodes_t enum.
*/

6
Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.c
View file

@ -67,9 +67,9 @@ void Bluetooth_Stack_USBTask(void)
/** Retrieves the channel information structure with the given local or remote channel number from the channel list.
*
* \param ChannelNumber Channel number to search for in the channel list
* \param SearchByRemoteChannel Indicated whether to search for a channel information structure by the given remote channel
* or local channel number
* \param[in] ChannelNumber Channel number to search for in the channel list
* \param[in] SearchByRemoteChannel Indicated whether to search for a channel information structure by the given remote channel
* or local channel number
*
* \return Pointer to the matching channel information structure in the channel table if found, NULL otherwise
*/