]> granicus.if.org Git - esp-idf/commitdiff
docu makup update
authorKrzysztof <krzychb@gazeta.pl>
Sat, 29 Oct 2016 18:54:58 +0000 (20:54 +0200)
committerIvan Grokhotkov <ivan@espressif.com>
Mon, 31 Oct 2016 17:21:18 +0000 (01:21 +0800)
components/bt/include/bt.h

index 1e89f96aa1a328acf3f12107cea252c929a58dc8..f476334b12ba4d85e834ffb5dfb7dadb324c129c 100644 (file)
@@ -28,37 +28,36 @@ extern "C" {
  *
  * This function should be called only once, before any other BT functions are called.
  */
-void bt_controller_init();
+void bt_controller_init(void);
 
-/** @brief: vhci_host_callback
+/** @brief vhci_host_callback
  *  used for vhci call host function to notify what host need to do
  *  
  *  notify_host_send_available: notify host can send packet to controller
  *  notify_host_recv: notify host that controller has packet send to host
  */
 typedef struct vhci_host_callback {
-
     void (*notify_host_send_available)(void);
     int (*notify_host_recv)(uint8_t *data, uint16_t len);
 } vhci_host_callback_t;
 
-/** @brief: API_vhci_host_check_send_available
+/** @brief API_vhci_host_check_send_available
  *  used for check actively if the host can send packet to controller or not.
- *  return true for ready to send, false means cannot send packet
+ *  @return true for ready to send, false means cannot send packet
  */
 bool API_vhci_host_check_send_available(void);
 
-/** @brief: API_vhci_host_send_packet
+/** @brief API_vhci_host_send_packet
  * host send packet to controller
- * param data is the packet point, the param len is the packet length
- * return void
+ * @param data the packet point
+ *,@param len the packet length
  */
 void API_vhci_host_send_packet(uint8_t *data, uint16_t len);
 
-/** @brief: API_vhci_host_register_callback
+/** @brief API_vhci_host_register_callback
  * register the vhci referece callback, the call back
  * struct defined by vhci_host_callback structure.
- * param is the vhci_host_callback type variable
+ * @param callback vhci_host_callback type variable
  */
 void API_vhci_host_register_callback(const vhci_host_callback_t *callback);