Skip to content

SocketAddress doxygen cleanup #9300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

SocketAddress doxygen cleanup #9300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions features/netsocket/SocketAddress.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

/** \addtogroup netsocket */
/** @{*/
/* SocketAddress
* Copyright (c) 2015 ARM Limited
*
Expand All @@ -25,11 +27,8 @@
class NetworkStack;
class NetworkInterface;


/** SocketAddress class
*
* Representation of an IP address and port pair.
* @addtogroup netsocket
*/
class SocketAddress {
public:
Expand All @@ -40,6 +39,7 @@ class SocketAddress {
*
* 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 host Hostname to resolve
* @param port Optional 16-bit port, defaults to 0
Expand All @@ -58,7 +58,7 @@ class SocketAddress {

/** 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 port Optional 16-bit port, defaults to 0
Expand Down Expand Up @@ -125,7 +125,7 @@ class SocketAddress {
*/
const char *get_ip_address() const;

/* Get the raw IP bytes
/** Get the raw IP bytes
*
* @return Raw IP address in big-endian order
*/
Expand Down