aZholtikov/zh_syslog
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: updated comments

Browse Source
This commit is contained in:
aZholtikov committed 2026-08-16 08:56:53 +03:00
1 parent 93e54ce764
commit 6f636f88ed
2 files changed
+5 -5
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

WIKI_EN.md
+1 -1
View File
@@ -127,7 +127,7 @@ Initializes the syslog client by creating a UDP socket and configuring the desti
**Parameters:** **Parameters:**
- `config` - Pointer to `zh_syslog_init_config_t` with syslog server address and port. Can point to a temporary variable. - `config` - Pointer to `zh_syslog_init_config_t` with syslog server address and port. Can point to a temporary variable. Must not be NULL
**Returns:** **Returns:**
include/zh_syslog.h
+4 -4
View File
@@ -116,7 +116,7 @@ extern "C"
* Creates a UDP socket and configures connection parameters * Creates a UDP socket and configures connection parameters
* for the remote syslog server. * for the remote syslog server.
* *
* @param[in] config Pointer to syslog client initialization configuration structure. Can point to a temporary variable * @param[in] config Pointer to syslog client initialization configuration structure. Can point to a temporary variable (must not be NULL)
* *
* @return ESP_OK on success * @return ESP_OK on success
* @return ESP_ERR_INVALID_ARG if config is NULL * @return ESP_ERR_INVALID_ARG if config is NULL
@@ -147,9 +147,9 @@ extern "C"
* *
* @param[in] facility Syslog facility code (0-23) * @param[in] facility Syslog facility code (0-23)
* @param[in] severity Syslog severity code (0-7) * @param[in] severity Syslog severity code (0-7)
* @param[in] hostname Pointer to device hostname that generated the message. Only alphanumeric characters without spaces * @param[in] hostname Pointer to device hostname that generated the message. Only alphanumeric characters without spaces (must not be NULL)
* @param[in] app_name Pointer to application name that generated the message. Only alphanumeric characters without spaces * @param[in] app_name Pointer to application name that generated the message. Only alphanumeric characters without spaces (must not be NULL)
* @param[in] message Pointer to the message payload to send * @param[in] message Pointer to the message payload to send (must not be NULL)
* *
* @return ESP_OK on success * @return ESP_OK on success
* @return ESP_ERR_INVALID_ARG if hostname, app_name, or message is NULL * @return ESP_ERR_INVALID_ARG if hostname, app_name, or message is NULL