Updated doxygen

This commit is contained in:
RobinVdB8
2023-11-26 17:13:15 +01:00
parent 1e7638c63d
commit 5600aa20f3

View File

@@ -61,7 +61,7 @@ static const char* TAG = "MQTT";
/** /**
* @brief callback function for publishing data * @brief callback function for publishing data
* *
* @param[in] arg * @param[in] arg User supplied argument to connection callback
* @param[in] result Whether the publish was successful or not * @param[in] result Whether the publish was successful or not
*/ */
static void mqtt_pub_request_cb(void* arg, err_t result) { static void mqtt_pub_request_cb(void* arg, err_t result) {
@@ -73,7 +73,7 @@ static void mqtt_pub_request_cb(void* arg, err_t result) {
* Publishes the names of all the .bmp and .gif files on the topic getImageList * Publishes the names of all the .bmp and .gif files on the topic getImageList
* *
* @param[in] client Pointer to the MQTT client * @param[in] client Pointer to the MQTT client
* @param[in] arg * @param[in] arg Additional argument to pass to the callback function
*/ */
static void publish_data(mqtt_client_t* client, void* arg) { static void publish_data(mqtt_client_t* client, void* arg) {
char pub_payload[200] = {0}; char pub_payload[200] = {0};
@@ -101,7 +101,7 @@ static void publish_data(mqtt_client_t* client, void* arg) {
* @brief Handles incoming publish * @brief Handles incoming publish
* Callback function for when data was published to a subscribed topic * Callback function for when data was published to a subscribed topic
* *
* @param[in] arg * @param[in] arg User supplied argument to connection callback
* @param[in] topic The topic on which an incoming publish was received * @param[in] topic The topic on which an incoming publish was received
* @param[in] tot_len Length of the incoming data * @param[in] tot_len Length of the incoming data
*/ */
@@ -132,7 +132,7 @@ static void mqtt_incoming_publish_cb(void* arg, const char* topic, uint32_t tot_
* @brief Handles incoming publish data * @brief Handles incoming publish data
* Handles the received data from a publish to a subscribed topic * Handles the received data from a publish to a subscribed topic
* *
* @param[in] arg * @param[in] arg User supplied argument to connection callback
* @param[in] data The incoming data * @param[in] data The incoming data
* @param[in] len Length of the data * @param[in] len Length of the data
* @param[in] flags Whether this is the last fragment of the incoming data * @param[in] flags Whether this is the last fragment of the incoming data
@@ -190,8 +190,8 @@ static void mqtt_incoming_data_cb(void* arg, const uint8_t* data, uint16_t len,
/** /**
* @brief Callback function for outgoing subscribe request * @brief Callback function for outgoing subscribe request
* *
* @param[in] arg * @param[in] arg User supplied argument to connection callback
* @param[in] result * @param[in] result Result code for the subscribe request
*/ */
static void mqtt_sub_request_cb(void* arg, err_t result) { static void mqtt_sub_request_cb(void* arg, err_t result) {
LOG_DEBUG(TAG, "Subscribe result: %d", result); LOG_DEBUG(TAG, "Subscribe result: %d", result);
@@ -203,7 +203,7 @@ static void mqtt_sub_request_cb(void* arg, err_t result) {
* subscribes to the input topics and calls the publish_data function. * subscribes to the input topics and calls the publish_data function.
* *
* @param[in] client Pointer to the MQTT client * @param[in] client Pointer to the MQTT client
* @param[in] arg * @param[in] arg User supplied argument to connection callback
* @param[in] status Connect result code or disconnection notification * @param[in] status Connect result code or disconnection notification
*/ */
static void mqtt_connection_cb(mqtt_client_t* client, void* arg, mqtt_connection_status_t status) { static void mqtt_connection_cb(mqtt_client_t* client, void* arg, mqtt_connection_status_t status) {