commit 029a0db7614f9ca5a48beaf29d075dc6fafeecb2
parent 051543c78d1787a1f298da84346bbaf494ae9da7
Author: Evgeny Grin (Karlson2k) <k2k@drgrin.dev>
Date: Sat, 22 Mar 2025 12:15:40 +0300
microhttpd2.h: a few English fixes
Diffstat:
3 files changed, 32 insertions(+), 36 deletions(-)
diff --git a/src/include/microhttpd2.h b/src/include/microhttpd2.h
@@ -149,13 +149,13 @@ MHD_C_DECLRATIONS_START_HERE_
#include "microhttpd2_portability.h"
-/* If generic headers don't work on your platform, include headers which define
- 'va_list', 'size_t', 'uint_least16_t', 'uint_fast32_t', 'uint_fast64_t',
- 'struct sockaddr', and then "#define MHD_HAVE_SYS_HEADERS_INCLUDED" before
- including "microhttpd2.h".
- When 'MHD_HAVE_SYS_HEADERS_INCLUDED' is defined the following "standard"
- includes won't be used (which might be a good idea, especially on platforms
- where they do not exist).
+/* If generic headers do not work on your platform, include headers that
+ define 'va_list', 'size_t', 'uint_least16_t', 'uint_fast32_t',
+ 'uint_fast64_t', and 'struct sockaddr', and then
+ add "#define MHD_HAVE_SYS_HEADERS_INCLUDED" before including "microhttpd2.h".
+ When 'MHD_HAVE_SYS_HEADERS_INCLUDED' is defined, the following "standard"
+ includes will not be used (which might be a good idea, especially on
+ platforms where they do not exist).
*/
#ifndef MHD_HAVE_SYS_HEADERS_INCLUDED
# include <stdarg.h>
@@ -289,7 +289,7 @@ typedef SOCKET MHD_Socket;
/**
* Constant used to indicate unlimited wait time.
- * Any possible larger values are interpreted as the this value.
+ * Any possible larger values are interpreted as this value.
*/
#ifdef UINT64_MAX
# define MHD_WAIT_INDEFINITELY UINT64_MAX
@@ -8527,8 +8527,7 @@ struct MHD_AuthBasicCreds
/**
- * Types of information about MHD,
- * used by #MHD_lib_get_info_fixed_sz().
+ * Types of information about MHD, used by #MHD_lib_get_info_fixed_sz().
* This information is not changed at run-time.
*/
enum MHD_FIXED_ENUM_APP_SET_ MHD_LibInfoFixed
@@ -8977,7 +8976,7 @@ union MHD_LibInfoFixedData
* the requested type of information is valid, the function always succeeds
* and returns #MHD_SC_OK.
*
- * The wrapper macro #MHD_lib_get_info_fixed() could be more convenient.
+ * The wrapper macro #MHD_lib_get_info_fixed() may be more convenient.
*
* @param info_type the type of requested information
* @param[out] output_buf the pointer to union to be set to the requested
@@ -9065,8 +9064,7 @@ MHD_STATIC_INLINE_END_
#endif /* ! MHD_NO_STATIC_INLINE */
/**
- * Types of information about MHD,
- * used by #MHD_lib_get_info_dynamic_sz().
+ * Types of information about MHD, used by #MHD_lib_get_info_dynamic_sz().
* This information may vary over time.
*/
enum MHD_FIXED_ENUM_APP_SET_ MHD_LibInfoDynamic
@@ -9183,10 +9181,10 @@ MHD_FN_MUST_CHECK_RESULT_ MHD_FN_PAR_NONNULL_ (2) MHD_FN_PAR_OUT_ (2);
/**
- * Values of this enum are used to specify what
- * information about a daemon is desired.
- * This types of information are not changed at after start of the daemon until
- * the daemon is destroyed.
+ * Values of this enum are used to specify what information about a daemon is
+ * requested.
+ * These types of information do not change after the start of the daemon
+ * until the daemon is destroyed.
*/
enum MHD_DaemonInfoFixedType
{
@@ -9290,7 +9288,7 @@ union MHD_DaemonInfoFixedData
* Obtain fixed information about the given daemon.
* This information is not changed at after start of the daemon until
* the daemon is destroyed.
- * The wrapper macro #MHD_daemon_get_info_fixed() could be more convenient.
+ * The wrapper macro #MHD_daemon_get_info_fixed() may be more convenient.
*
* @param daemon the daemon to get information about
* @param info_type the type of information requested
diff --git a/src/include/microhttpd2_main.h.in b/src/include/microhttpd2_main.h.in
@@ -3905,8 +3905,7 @@ struct MHD_AuthBasicCreds
/**
- * Types of information about MHD,
- * used by #MHD_lib_get_info_fixed_sz().
+ * Types of information about MHD, used by #MHD_lib_get_info_fixed_sz().
* This information is not changed at run-time.
*/
enum MHD_FIXED_ENUM_APP_SET_ MHD_LibInfoFixed
@@ -4355,7 +4354,7 @@ union MHD_LibInfoFixedData
* the requested type of information is valid, the function always succeeds
* and returns #MHD_SC_OK.
*
- * The wrapper macro #MHD_lib_get_info_fixed() could be more convenient.
+ * The wrapper macro #MHD_lib_get_info_fixed() may be more convenient.
*
* @param info_type the type of requested information
* @param[out] output_buf the pointer to union to be set to the requested
@@ -4443,8 +4442,7 @@ MHD_STATIC_INLINE_END_
#endif /* ! MHD_NO_STATIC_INLINE */
/**
- * Types of information about MHD,
- * used by #MHD_lib_get_info_dynamic_sz().
+ * Types of information about MHD, used by #MHD_lib_get_info_dynamic_sz().
* This information may vary over time.
*/
enum MHD_FIXED_ENUM_APP_SET_ MHD_LibInfoDynamic
@@ -4561,10 +4559,10 @@ MHD_FN_MUST_CHECK_RESULT_ MHD_FN_PAR_NONNULL_ (2) MHD_FN_PAR_OUT_ (2);
/**
- * Values of this enum are used to specify what
- * information about a daemon is desired.
- * This types of information are not changed at after start of the daemon until
- * the daemon is destroyed.
+ * Values of this enum are used to specify what information about a daemon is
+ * requested.
+ * These types of information do not change after the start of the daemon
+ * until the daemon is destroyed.
*/
enum MHD_DaemonInfoFixedType
{
@@ -4668,7 +4666,7 @@ union MHD_DaemonInfoFixedData
* Obtain fixed information about the given daemon.
* This information is not changed at after start of the daemon until
* the daemon is destroyed.
- * The wrapper macro #MHD_daemon_get_info_fixed() could be more convenient.
+ * The wrapper macro #MHD_daemon_get_info_fixed() may be more convenient.
*
* @param daemon the daemon to get information about
* @param info_type the type of information requested
diff --git a/src/include/microhttpd2_preamble.h.in b/src/include/microhttpd2_preamble.h.in
@@ -149,13 +149,13 @@ MHD_C_DECLRATIONS_START_HERE_
#include "microhttpd2_portability.h"
-/* If generic headers don't work on your platform, include headers which define
- 'va_list', 'size_t', 'uint_least16_t', 'uint_fast32_t', 'uint_fast64_t',
- 'struct sockaddr', and then "#define MHD_HAVE_SYS_HEADERS_INCLUDED" before
- including "microhttpd2.h".
- When 'MHD_HAVE_SYS_HEADERS_INCLUDED' is defined the following "standard"
- includes won't be used (which might be a good idea, especially on platforms
- where they do not exist).
+/* If generic headers do not work on your platform, include headers that
+ define 'va_list', 'size_t', 'uint_least16_t', 'uint_fast32_t',
+ 'uint_fast64_t', and 'struct sockaddr', and then
+ add "#define MHD_HAVE_SYS_HEADERS_INCLUDED" before including "microhttpd2.h".
+ When 'MHD_HAVE_SYS_HEADERS_INCLUDED' is defined, the following "standard"
+ includes will not be used (which might be a good idea, especially on
+ platforms where they do not exist).
*/
#ifndef MHD_HAVE_SYS_HEADERS_INCLUDED
# include <stdarg.h>
@@ -289,7 +289,7 @@ typedef SOCKET MHD_Socket;
/**
* Constant used to indicate unlimited wait time.
- * Any possible larger values are interpreted as the this value.
+ * Any possible larger values are interpreted as this value.
*/
#ifdef UINT64_MAX
# define MHD_WAIT_INDEFINITELY UINT64_MAX
