docs: fix return error of ota docs and fix ota.rst

diff --git a/components/app_update/include/esp_ota_ops.h b/components/app_update/include/esp_ota_ops.h
index 614ac18172822d0c72a1798d35cfe7080654929e..846aa2b2cf1b0725f13d355f28d68dcd306038e2 100755 (executable)
--- a/components/app_update/include/esp_ota_ops.h
+++ b/components/app_update/include/esp_ota_ops.h
@@ -49,9 +49,10 @@ typedef uint32_t esp_ota_handle_t;
  * @param   image_size size of image need to be updated
  * @param   out_handle handle which should be used for esp_ota_write or esp_ota_end call
 
- * @return: ESP_OK if format ota image OK  
- *          ESP_ERR_OTA_PARTITION_CONFLICT  operate current running bin  
- *          ESP_ERR_OTA_SELECT_INFO_INVALID ota bin select info invalid
+ * @return: 
+ *    - ESP_OK: if format ota image OK  
+ *    - ESP_ERR_OTA_PARTITION_CONFLICT: operate current running bin  
+ *    - ESP_ERR_OTA_SELECT_INFO_INVALID: ota bin select info invalid
  */
 esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp_ota_handle_t* out_handle);
 
@@ -62,9 +63,10 @@ esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp
  * @param   data  Pointer to data write to flash
  * @param   size  data size of recieved data
  *
- * @return: ESP_OK if write flash data OK 
- *          ESP_ERR_OTA_PARTITION_CONFLICT  operate current running bin  
- *          ESP_ERR_OTA_SELECT_INFO_INVALID ota bin select info invalid
+ * @return: 
+ *    - ESP_OK: if write flash data OK 
+ *    - ESP_ERR_OTA_PARTITION_CONFLICT: operate current running bin  
+ *    - ESP_ERR_OTA_SELECT_INFO_INVALID: ota bin select info invalid
  */
 esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size);
  
@@ -73,8 +75,9 @@ esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size);
  *
  * @param   handle  Handle obtained from esp_ota_begin 
  *
- * @return: ESP_OK if validate ota image pass
- *          ESP_ERR_OTA_VALIDATE_FAILED  validate the ota image is invalid
+ * @return: 
+ *    - ESP_OK: if validate ota image pass
+ *    - ESP_ERR_OTA_VALIDATE_FAILED: validate the ota image is invalid
  */
 esp_err_t esp_ota_end(esp_ota_handle_t handle);
 
@@ -86,8 +89,9 @@ esp_err_t esp_ota_end(esp_ota_handle_t handle);
  *
  * @param   partition Pointer to partition structure which need to boot
  *
- * @return: ESP_OK if set next boot partition OK
- *          ESP_ERR_OTA_SELECT_INFO_INVALID ota bin select info invalid
+ * @return: 
+ *    - ESP_OK: if set next boot partition OK
+ *    - ESP_ERR_OTA_SELECT_INFO_INVALID: ota bin select info invalid
  */
 esp_err_t esp_ota_set_boot_partition(const esp_partition_t* partition);
 

diff --git a/docs/api/ota.rst b/docs/api/ota.rst
index cb181d366f645d395799ff064527fe9f7c9497e0..a4984620f6e5883ada2da0c1b8d9bb22b44d5775 100644 (file)
--- a/docs/api/ota.rst
+++ b/docs/api/ota.rst
@@ -1,30 +1,16 @@
 OTA
 ===
 
-Overview
---------
-
-`Instructions`_
-
-Application Example
--------------------
-
-`Instructions`_
-
 API Reference
 -------------
 
-`Instructions`_
-
-.. _Instructions: template.html
-
 Header Files
 ^^^^^^^^^^^^
 
   * `app_update/include/esp_ota_ops.h <https://github.com/espressif/esp-idf/blob/master/components/app_update/include/esp_ota_ops.h>`_
 
 Macros
-------
+^^^^^^
 
 .. doxygendefine:: ESP_ERR_OTA_BASE
 .. doxygendefine:: ESP_ERR_OTA_PARTITION_CONFLICT