Update doxygen comments in MAX32665 uart.h

analogdevicesinc · Oct 13, 2023 · e16c7de · e16c7de
1 parent f1d3fde
commit e16c7de
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/Libraries/PeriphDrivers/Include/MAX32665/uart.h b/Libraries/PeriphDrivers/Include/MAX32665/uart.h
@@ -644,6 +644,8 @@ void MXC_UART_DMACallback(int ch, int error);
  *
  * @param      uart    The uart
  * @param[in]  retVal  The ret value
+ * 
+ * @return  See \ref MXC_Error_Codes for the list of error return codes.
  */
 int MXC_UART_AsyncCallback(mxc_uart_regs_t *uart, int retVal);
 int MXC_UART_TxAsyncCallback(mxc_uart_regs_t *uart, int retVal);
@@ -653,6 +655,8 @@ int MXC_UART_RxAsyncCallback(mxc_uart_regs_t *uart, int retVal);
  * @brief   stop any async callbacks
  *
  * @param   uart  The uart
+ * 
+ * @return  See \ref MXC_Error_Codes for the list of error return codes.
  */
 int MXC_UART_AsyncStop(mxc_uart_regs_t *uart);
 int MXC_UART_TxAsyncStop(mxc_uart_regs_t *uart);
@@ -666,6 +670,8 @@ int MXC_UART_RxAsyncStop(mxc_uart_regs_t *uart);
  * has been terminated.
  *
  * @param   uart         Pointer to UART registers (selects the UART block used.)
+ * 
+ * @return  See \ref MXC_Error_Codes for the list of error return codes.
  */
 int MXC_UART_AbortAsync(mxc_uart_regs_t *uart);
 int MXC_UART_TxAbortAsync(mxc_uart_regs_t *uart);