]> granicus.if.org Git - esp-idf/commitdiff
components/esp32,bt: fix typos in comments
authorIvan Grokhotkov <ivan@espressif.com>
Sun, 25 Sep 2016 16:51:56 +0000 (00:51 +0800)
committerIvan Grokhotkov <ivan@espressif.com>
Sun, 25 Sep 2016 16:51:56 +0000 (00:51 +0800)
components/bt/include/bt.h
components/esp32/include/esp_event.h
components/esp32/include/esp_task.h

index 0dc04249396a11f1651c39221f1d1991ffd52fb4..1e89f96aa1a328acf3f12107cea252c929a58dc8 100644 (file)
@@ -30,7 +30,7 @@ extern "C" {
  */
 void bt_controller_init();
 
-/* @breif: 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
@@ -42,20 +42,20 @@ typedef struct vhci_host_callback {
     int (*notify_host_recv)(uint8_t *data, uint16_t len);
 } vhci_host_callback_t;
 
-/* @breif: 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
  */
 bool API_vhci_host_check_send_available(void);
 
-/* @breif: 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
  */
 void API_vhci_host_send_packet(uint8_t *data, uint16_t len);
 
-/* @breif: 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
index 0b61b70219a4e1ed617e624a0a384f99a3706609..34358a26750dbdd473aad5397beef7f3fb5d2457 100644 (file)
@@ -101,7 +101,7 @@ typedef union {
 } system_event_info_t;
 
 typedef struct {
-    system_event_id_t     event_id;      /**< even ID */
+    system_event_id_t     event_id;      /**< event ID */
     system_event_info_t   event_info;    /**< event information */
 } system_event_t;
 
index 0a68e5d919eb1574549cf2457fb92f14b68e2ea4..bb028bf48582635a3cd8590bf840df49ee6e95c5 100644 (file)
 /* Notes:
  * 1. Put all task priority and stack size definition in this file
  * 2. If the task priority is less than 10, use ESP_TASK_PRIO_MIN + X style,
- *    otherwise use ESP_TASK_PRIO_MIN - X style
- * 3. If this is a daemon task, the macro prifix is ESP_TASKD_, otherwise
+ *    otherwise use ESP_TASK_PRIO_MAX - X style
+ * 3. If this is a daemon task, the macro prefix is ESP_TASKD_, otherwise
  *    it's ESP_TASK_
- * 4. If the configMAX_PRIORITIES is modified, please make all prority are 
+ * 4. If the configMAX_PRIORITIES is modified, please make all priority are
  *    greater than 0
  * 5. Make sure esp_task.h is consistent between wifi lib and idf
  */