Skip to content

Commit 8cbc2b9

Browse files
author
Jarno Lamsa
committed
SocketAddress doxygen cleanup
1 parent c27dabe commit 8cbc2b9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

features/netsocket/SocketAddress.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11

2+
/** \addtogroup netsocket */
3+
/** @{*/
24
/* SocketAddress
35
* Copyright (c) 2015 ARM Limited
46
*
@@ -25,11 +27,8 @@
2527
class NetworkStack;
2628
class NetworkInterface;
2729

28-
2930
/** SocketAddress class
30-
*
3131
* Representation of an IP address and port pair.
32-
* @addtogroup netsocket
3332
*/
3433
class SocketAddress {
3534
public:
@@ -40,6 +39,7 @@ class SocketAddress {
4039
*
4140
* On failure, the IP address and port will be set to zero
4241
*
42+
* @tparam S Type of the Network stack
4343
* @param stack Network stack to use for DNS resolution
4444
* @param host Hostname to resolve
4545
* @param port Optional 16-bit port, defaults to 0
@@ -58,7 +58,7 @@ class SocketAddress {
5858

5959
/** Create a SocketAddress from a raw IP address and port
6060
*
61-
* To construct from a host name, use NetworkInterface::gethostbyname
61+
* @note To construct from a host name, use NetworkInterface::gethostbyname
6262
*
6363
* @param addr Raw IP address
6464
* @param port Optional 16-bit port, defaults to 0
@@ -125,7 +125,7 @@ class SocketAddress {
125125
*/
126126
const char *get_ip_address() const;
127127

128-
/* Get the raw IP bytes
128+
/** Get the raw IP bytes
129129
*
130130
* @return Raw IP address in big-endian order
131131
*/

0 commit comments

Comments
 (0)