Skip to content

Commit 25b1625

Browse files
author
Mel W
authored
Sentence restructuring, punctuation
1 parent 446ab5d commit 25b1625

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

features/netsocket/DNS.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,26 +52,26 @@ class DNS {
5252
*/
5353
typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t;
5454

55-
/** Translate a hostname to an IP address (asynchronous)
55+
/** Translate a hostname to an IP address (asynchronous).
5656
*
5757
* The hostname may be either a domain name or an IP address. If the
5858
* hostname is an IP address, no network transactions will be performed.
5959
*
6060
* If no stack-specific DNS resolution is provided, the hostname
61-
* will be resolve using a UDP socket on the stack.
61+
* will be resolved using a UDP socket on the stack.
6262
*
6363
* Call is non-blocking. Result of the DNS operation is returned by the callback.
64-
* If this function returns failure, callback will not be called. In case result
65-
* is success (IP address was found from DNS cache), callback will be called
64+
* If this function returns failure, callback will not be called. If it is successful,
65+
* (IP address was found from DNS cache), callback will be called
6666
* before function returns.
6767
*
6868
* @param host Hostname to resolve.
6969
* @param callback Callback that is called to return the result.
70-
* @param version IP version of address to resolve, NSAPI_UNSPEC indicates
70+
* @param version IP version of address to resolve. NSAPI_UNSPEC indicates
7171
* version is chosen by the stack (defaults to NSAPI_UNSPEC).
7272
* @return NSAPI_ERROR_OK on immediate success,
7373
* negative error code on immediate failure or
74-
* a positive unique id that represents the hostname translation operation
74+
* a positive unique ID that represents the hostname translation operation
7575
* and can be passed to cancel.
7676
*/
7777
virtual nsapi_value_or_error_t gethostbyname_async(const char *host, hostbyname_cb_t callback,
@@ -86,7 +86,7 @@ class DNS {
8686
*/
8787
virtual nsapi_error_t gethostbyname_async_cancel(int id) = 0;
8888

89-
/** Add a domain name server to list of servers to query
89+
/** Add a domain name server to list of servers to query.
9090
*
9191
* @param address DNS server host address.
9292
* @return NSAPI_ERROR_OK on success, negative error code on failure.

0 commit comments

Comments
 (0)