From c1b13306800170fe5f9ccdb6f422533e6d7ba3cf Mon Sep 17 00:00:00 2001 From: David Cermak Date: Thu, 17 Jun 2021 16:46:45 +0200 Subject: [PATCH] esp_modem(Docs): Minor correction of the docs --- components/esp_modem/docs/README.md | 2 +- components/esp_modem/include/cxx_include/esp_modem_types.hpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/components/esp_modem/docs/README.md b/components/esp_modem/docs/README.md index 68d929e93..0a0b32662 100644 --- a/components/esp_modem/docs/README.md +++ b/components/esp_modem/docs/README.md @@ -74,6 +74,6 @@ Currently we support only UART, but modern modules support other communication i ### Other devices -Adding a new device is a must-have requirement for the esp-component. Different modules support different commands, +Adding a new device is a must-have requirement for the esp-modem component. Different modules support different commands, or some commands might have a different implementation. Adding a new device means to provide a new implementation as a class derived from `GenericModule`, where we could add new commands or modify the existing ones. diff --git a/components/esp_modem/include/cxx_include/esp_modem_types.hpp b/components/esp_modem/include/cxx_include/esp_modem_types.hpp index 722d3f85f..17c5d68e5 100644 --- a/components/esp_modem/include/cxx_include/esp_modem_types.hpp +++ b/components/esp_modem/include/cxx_include/esp_modem_types.hpp @@ -84,7 +84,7 @@ public: class ModuleIf { public: /** - * @brief Sets the data mode up (provides the necessary configuration to connect to the cellular network + * @brief Sets the data mode up (provides the necessary configuration to connect to the cellular network) * @return true on success */ virtual bool setup_data_mode() = 0;