1
1
2
+ /* * \addtogroup netsocket */
3
+ /* * @{*/
2
4
/* SocketAddress
3
5
* Copyright (c) 2015 ARM Limited
4
6
*
25
27
class NetworkStack ;
26
28
class NetworkInterface ;
27
29
28
-
29
30
/* * SocketAddress class
30
- *
31
31
* Representation of an IP address and port pair.
32
- * @addtogroup netsocket
33
32
*/
34
33
class SocketAddress {
35
34
public:
@@ -40,6 +39,7 @@ class SocketAddress {
40
39
*
41
40
* On failure, the IP address and port will be set to zero
42
41
*
42
+ * @tparam S Type of the Network stack
43
43
* @param stack Network stack to use for DNS resolution
44
44
* @param host Hostname to resolve
45
45
* @param port Optional 16-bit port, defaults to 0
@@ -58,7 +58,7 @@ class SocketAddress {
58
58
59
59
/* * Create a SocketAddress from a raw IP address and port
60
60
*
61
- * To construct from a host name, use NetworkInterface::gethostbyname
61
+ * @note To construct from a host name, use NetworkInterface::gethostbyname
62
62
*
63
63
* @param addr Raw IP address
64
64
* @param port Optional 16-bit port, defaults to 0
@@ -125,7 +125,7 @@ class SocketAddress {
125
125
*/
126
126
const char *get_ip_address () const ;
127
127
128
- /* Get the raw IP bytes
128
+ /* * Get the raw IP bytes
129
129
*
130
130
* @return Raw IP address in big-endian order
131
131
*/
0 commit comments