i2s: deprecate confusing names

components/esp_system/include/esp_system.h

@@ -1,16 +1,8 @@
-// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+/*
+ * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
 
 #ifndef __ESP_SYSTEM_H__
 #define __ESP_SYSTEM_H__
@@ -86,7 +78,7 @@ esp_err_t esp_unregister_shutdown_handler(shutdown_handler_t handle);
   *
   * This function can be called both from PRO and APP CPUs.
   * After successful restart, CPU reset reason will be SW_CPU_RESET.
-  * Peripherals (except for WiFi, BT, UART0, SPI1, and legacy timers) are not reset.
+  * Peripherals (except for Wi-Fi, BT, UART0, SPI1, and legacy timers) are not reset.
   * This function does not return.
   */
 void esp_restart(void) __attribute__ ((noreturn));
@@ -100,7 +92,7 @@ esp_reset_reason_t esp_reset_reason(void);
 /**
   * @brief  Get the size of available heap.
   *
-  * Note that the returned value may be larger than the maximum contiguous block
+  * @note Note that the returned value may be larger than the maximum contiguous block
   * which can be allocated.
   *
   * @return Available heap size, in bytes.
@@ -110,7 +102,7 @@ uint32_t esp_get_free_heap_size(void);
 /**
   * @brief  Get the size of available internal heap.
   *
-  * Note that the returned value may be larger than the maximum contiguous block
+  * @note Note that the returned value may be larger than the maximum contiguous block
   * which can be allocated.
   *
   * @return Available internal heap size, in bytes.