SocketAddress doxygen cleanup

Jarno Lamsa · Seppo Takalo · commit 981bfa139e28 · 2019-01-21T11:45:12.000+02:00
diff --git a/features/netsocket/SocketAddress.h b/features/netsocket/SocketAddress.h
@@ -28,7 +28,6 @@
 class NetworkStack;
 class NetworkInterface;
 
-
 /** SocketAddress class
  *
  *  Representation of an IP address and port pair.
@@ -42,6 +41,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
@@ -60,7 +60,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
@@ -127,7 +127,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
      */

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@`
`28`	`28`	`class NetworkStack;`
`29`	`29`	`class NetworkInterface;`
`30`	`30`
`31`		`-`
`32`	`31`	`/** SocketAddress class`
`33`	`32`	`*`
`34`	`33`	`* Representation of an IP address and port pair.`
`@@ -42,6 +41,7 @@ class SocketAddress {`
`42`	`41`	`*`
`43`	`42`	`* On failure, the IP address and port will be set to zero`
`44`	`43`	`*`
	`44`	`+ * @tparam S Type of the Network stack`
`45`	`45`	`* @param stack Network stack to use for DNS resolution`
`46`	`46`	`* @param host Hostname to resolve`
`47`	`47`	`* @param port Optional 16-bit port, defaults to 0`
`@@ -60,7 +60,7 @@ class SocketAddress {`
`60`	`60`
`61`	`61`	`/** Create a SocketAddress from a raw IP address and port`
`62`	`62`	`*`
`63`		`- * To construct from a host name, use NetworkInterface::gethostbyname`
	`63`	`+ * @note To construct from a host name, use NetworkInterface::gethostbyname`
`64`	`64`	`*`
`65`	`65`	`* @param addr Raw IP address`
`66`	`66`	`* @param port Optional 16-bit port, defaults to 0`
`@@ -127,7 +127,7 @@ class SocketAddress {`
`127`	`127`	`*/`
`128`	`128`	`const char *get_ip_address() const;`
`129`	`129`
`130`		`- /* Get the raw IP bytes`
	`130`	`+ /** Get the raw IP bytes`
`131`	`131`	`*`
`132`	`132`	`* @return Raw IP address in big-endian order`
`133`	`133`	`*/`