From 314d3462bc3d555ec4c74ac3107eb1c1cb506b7a Mon Sep 17 00:00:00 2001 From: David Cermak Date: Mon, 19 Apr 2021 11:55:42 +0200 Subject: [PATCH] API: Document create APIs for DTE and DCE --- esp_modem/include/cxx_include/esp_modem_api.hpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/esp_modem/include/cxx_include/esp_modem_api.hpp b/esp_modem/include/cxx_include/esp_modem_api.hpp index f9efc8502..528bb06da 100644 --- a/esp_modem/include/cxx_include/esp_modem_api.hpp +++ b/esp_modem/include/cxx_include/esp_modem_api.hpp @@ -43,7 +43,9 @@ using dte_config = ::esp_modem_dte_config; /** * @brief Create UART DTE * @param config DTE configuration - * @return shared ptr to DTE + * @return shared ptr to DTE on success + * nullptr on failure (either due to insufficient memory or wrong dte configuration) + * if exceptions are disabled the API abort()'s on error */ std::shared_ptr create_uart_dte(const dte_config *config); /** @@ -66,6 +68,7 @@ std::shared_ptr create_uart_dte(const dte_config *config); * * @return unique ptr to the created DCE on success * nullptr on failure + * if exceptions are disabled the API abort()'s on error */ std::unique_ptr create_SIM7600_dce(const dce_config *config, std::shared_ptr dte, esp_netif_t *netif);