diff --git a/WIKI_EN.md b/WIKI_EN.md index 6377afc..2cf4801 100644 --- a/WIKI_EN.md +++ b/WIKI_EN.md @@ -127,7 +127,7 @@ Initializes the syslog client by creating a UDP socket and configuring the desti **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:** diff --git a/include/zh_syslog.h b/include/zh_syslog.h index b98a7fd..1478f95 100644 --- a/include/zh_syslog.h +++ b/include/zh_syslog.h @@ -116,7 +116,7 @@ extern "C" * Creates a UDP socket and configures connection parameters * 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_ERR_INVALID_ARG if config is NULL @@ -147,9 +147,9 @@ extern "C" * * @param[in] facility Syslog facility code (0-23) * @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] app_name Pointer to application name that generated the message. Only alphanumeric characters without spaces - * @param[in] message Pointer to the message payload to send + * @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 (must not be NULL) + * @param[in] message Pointer to the message payload to send (must not be NULL) * * @return ESP_OK on success * @return ESP_ERR_INVALID_ARG if hostname, app_name, or message is NULL