diff options
| author | rubidium <rubidium@openttd.org> | 2011-05-01 13:29:40 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2011-05-01 13:29:40 +0000 |
| commit | 99ec3a044aab32e0fe4aea03a5539cf0e4f129e9 (patch) | |
| tree | 8d9cdc4b81d2d7c4a9ca505656b837777e38092a /src/network/core/address.h | |
| parent | 536c581923e456ed6a0d1a47747b7c9e111d8755 (diff) | |
| download | openttd-99ec3a044aab32e0fe4aea03a5539cf0e4f129e9.tar.xz | |
(svn r22403) -Document: some more network/core code
Diffstat (limited to 'src/network/core/address.h')
| -rw-r--r-- | src/network/core/address.h | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/src/network/core/address.h b/src/network/core/address.h index 3a23703ce..d2d43b4a9 100644 --- a/src/network/core/address.h +++ b/src/network/core/address.h @@ -20,8 +20,8 @@ #ifdef ENABLE_NETWORK class NetworkAddress; -typedef SmallVector<NetworkAddress, 4> NetworkAddressList; -typedef SmallMap<NetworkAddress, SOCKET, 4> SocketList; +typedef SmallVector<NetworkAddress, 4> NetworkAddressList; ///< Type for a list of addresses. +typedef SmallMap<NetworkAddress, SOCKET, 4> SocketList; ///< Type for a mapping between address and socket. /** * Wrapper for (un)resolved network addresses; there's no reason to transform @@ -44,8 +44,9 @@ private: SOCKET Resolve(int family, int socktype, int flags, SocketList *sockets, LoopProc func); public: /** - * Create a network address based on a resolved IP and port - * @param address the IP address with port + * Create a network address based on a resolved IP and port. + * @param address The IP address with port. + * @param address_length The length of the address. */ NetworkAddress(struct sockaddr_storage &address, int address_length) : address_length(address_length), @@ -55,8 +56,9 @@ public: } /** - * Create a network address based on a resolved IP and port - * @param address the IP address with port + * Create a network address based on a resolved IP and port. + * @param address The IP address with port. + * @param address_length The length of the address. */ NetworkAddress(sockaddr *address, int address_length) : address_length(address_length) @@ -68,7 +70,7 @@ public: /** * Create a network address based on a unresolved host and port - * @param ip the unresolved hostname + * @param hostname the unresolved hostname * @param port the port * @param family the address family */ |