File tree Expand file tree Collapse file tree 1 file changed +16
-4
lines changed Expand file tree Collapse file tree 1 file changed +16
-4
lines changed Original file line number Diff line number Diff line change @@ -37,17 +37,29 @@ class ModemClass {
3737 /* *
3838 * @brief Initializes the modem communication with a specified baud rate.
3939 *
40- * @param The baud rate is set to 115200. Call function after creating an instance of the
41- * `ModemClass` to set up the communication parameters before sending or receiving data.
40+ * @param[in] `badurate` sets the baud rate for the serial connection.
4241 */
4342 void begin (int badurate = 115200 );
4443
4544 /* *
46- * @brief Shutts down the modem communication and releases any
47- * resources that were allocated during the communication process.
45+ * @brief Ends the modem communication.
4846 */
4947 void end ();
5048
49+
50+ /* *
51+ * @brief Sends a formatted command string to a device and stores the response.
52+ *
53+ * This function formats a command string using the provided format and arguments,
54+ * sends it to a device, and waits for a response, which is stored in the `str` string.
55+ *
56+ * @param cmd A string representing the command to be sent to the device.
57+ * @param str A reference to a string that will hold the device's response.
58+ * @param fmt A format string for constructing the command.
59+ *
60+ * @return `true` if the command was successfully sent and a response was received,
61+ * `false` otherwise.
62+ */
5163 /* *
5264 * @brief Sends a command to the modem and waits for a response.
5365 *
You can’t perform that action at this time.
0 commit comments