Minor documentation improvements.

[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / Lib / BluetoothACLPackets.c

diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
index f96e10c..108abbf 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.c
@@ -193,10 +193,10 @@ static void Bluetooth_ProcessIncommingACLPackets(void)
 \r
 /** Sends a packet to the remote device on the specified channel.\r
  *\r
 \r
 /** Sends a packet to the remote device on the specified channel.\r
  *\r

- * \param Data     Pointer to a buffer where the data is to be sourced from\r
- * \param DataLen  Length of the data to send\r
- * \param Channel  Channel information structure containing the destination channel's information, NULL to send\r
- *                 to the remote device's signalling channel\r
+ * \param[in] Data     Pointer to a buffer where the data is to be sourced from\r
+ * \param[in] DataLen  Length of the data to send\r
+ * \param[in] Channel  Channel information structure containing the destination channel's information, NULL to send\r
+ *                     to the remote device's signalling channel\r

  *\r
  * \return A value from the \ref BT_SendPacket_ErrorCodes_t enum\r
  */\r
  *\r
  * \return A value from the \ref BT_SendPacket_ErrorCodes_t enum\r
  */\r


@@ -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\r
  *        element has progressed to the Open state.\r
  *\r
  *        repeatedly called. The returned channel is unusable by the user application until its State\r
  *        element has progressed to the Open state.\r
  *\r

- *  \param PSM  PSM of the service that the channel is to be opened for\r
+ *  \param[in] PSM  PSM of the service that the channel is to be opened for\r

  *\r
  *  \return Pointer to the channel information structure of the opened channel, or NULL if no free channels\r
  */\r
  *\r
  *  \return Pointer to the channel information structure of the opened channel, or NULL if no free channels\r
  */\r


@@ -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\r
  *        closed until its State element has progressed to the Closed state.\r
  *\r
  *        returned channel is unusable by the user application upon return however the channel is not completely\r
  *        closed until its State element has progressed to the Closed state.\r
  *\r

- * \param Channel  Channel information structure of the channel to close\r
+ * \param[in,out] Channel  Channel information structure of the channel to close\r

  */\r
 void Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel)\r
 {\r
  */\r
 void Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel)\r
 {\r


@@ -346,7 +346,7 @@ void Bluetooth_CloseChannel(Bluetooth_Channel_t* Channel)
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Connection Request command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Connection Request command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_ConnectionReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_ConnectionReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -419,7 +419,7 @@ static inline void Bluetooth_Signal_ConnectionReq(BT_Signal_Header_t* SignalComm
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Connection Response command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Connection Response command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_ConnectionResp(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_ConnectionResp(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -450,7 +450,7 @@ static inline void Bluetooth_Signal_ConnectionResp(BT_Signal_Header_t* SignalCom
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Configuration Request command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Configuration Request command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_ConfigurationReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_ConfigurationReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -537,7 +537,7 @@ static inline void Bluetooth_Signal_ConfigurationReq(BT_Signal_Header_t* SignalC
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Configuration Response command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Configuration Response command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_ConfigurationResp(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_ConfigurationResp(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -581,7 +581,7 @@ static inline void Bluetooth_Signal_ConfigurationResp(BT_Signal_Header_t* Signal
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Disconnection Request command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Disconnection Request command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_DisconnectionReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_DisconnectionReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -627,7 +627,7 @@ static inline void Bluetooth_Signal_DisconnectionReq(BT_Signal_Header_t* SignalC
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Disconnection Response command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for a Disconnection Response command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_DisconnectionResp(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_DisconnectionResp(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -652,7 +652,7 @@ static inline void Bluetooth_Signal_DisconnectionResp(BT_Signal_Header_t* Signal
 \r
 /** Internal Bluetooth stack Signal Command processing routine for an Echo Request command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for an Echo Request command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_EchoReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_EchoReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r


@@ -678,7 +678,7 @@ static inline void Bluetooth_Signal_EchoReq(BT_Signal_Header_t* SignalCommandHea
 \r
 /** Internal Bluetooth stack Signal Command processing routine for an Information Request command.\r
  *\r
 \r
 /** Internal Bluetooth stack Signal Command processing routine for an Information Request command.\r
  *\r

- *  \param  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r
+ *  \param[in]  SignalCommandHeader  Pointer to the start of the received packet's Signal Command header\r

  */\r
 static inline void Bluetooth_Signal_InformationReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r
  */\r
 static inline void Bluetooth_Signal_InformationReq(BT_Signal_Header_t* SignalCommandHeader)\r
 {\r