ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

SocketAddress doxygen cleanup

pull/9328/head
Jarno Lamsa 2019-01-09 10:40:47 +02:00 committed by Seppo Takalo
parent 8f5e003a1e
commit 981bfa139e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
features/netsocket/SocketAddress.h
View File

@ -28,7 +28,6 @@
class NetworkStack; class NetworkStack;
class NetworkInterface; class NetworkInterface;
/** SocketAddress class /** SocketAddress class
* *
* Representation of an IP address and port pair. * Representation of an IP address and port pair.
@ -42,6 +41,7 @@ public:
* *
* On failure, the IP address and port will be set to zero * On failure, the IP address and port will be set to zero
* *
* @tparam S Type of the Network stack
* @param stack Network stack to use for DNS resolution * @param stack Network stack to use for DNS resolution
* @param host Hostname to resolve * @param host Hostname to resolve
* @param port Optional 16-bit port, defaults to 0 * @param port Optional 16-bit port, defaults to 0
@ -60,7 +60,7 @@ public:
/** Create a SocketAddress from a raw IP address and port /** Create a SocketAddress from a raw IP address and port
* *
* To construct from a host name, use NetworkInterface::gethostbyname * @note To construct from a host name, use NetworkInterface::gethostbyname
* *
* @param addr Raw IP address * @param addr Raw IP address
* @param port Optional 16-bit port, defaults to 0 * @param port Optional 16-bit port, defaults to 0
@ -127,7 +127,7 @@ public:
*/ */
const char *get_ip_address() const; const char *get_ip_address() const;
/* Get the raw IP bytes /** Get the raw IP bytes
* *
* @return Raw IP address in big-endian order * @return Raw IP address in big-endian order
*/ */