From 99ec3a044aab32e0fe4aea03a5539cf0e4f129e9 Mon Sep 17 00:00:00 2001 From: rubidium Date: Sun, 1 May 2011 13:29:40 +0000 Subject: (svn r22403) -Document: some more network/core code --- src/network/core/address.h | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'src/network/core/address.h') 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 NetworkAddressList; -typedef SmallMap SocketList; +typedef SmallVector NetworkAddressList; ///< Type for a list of addresses. +typedef SmallMap 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 */ -- cgit v1.2.3-70-g09d2