summaryrefslogtreecommitdiff
path: root/src/network
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2010-08-01 19:22:34 +0000
committerfrosch <frosch@openttd.org>2010-08-01 19:22:34 +0000
commited4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 (patch)
treedba65e1ae2fc4538779195db320eccfa441cbbd0 /src/network
parent4871baf44db96137cf4b72c4f9d9595b2c29f61d (diff)
downloadopenttd-ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3.tar.xz
(svn r20283) -Codechange: Unify start of doygen comments.
Diffstat (limited to 'src/network')
-rw-r--r--src/network/core/packet.h3
-rw-r--r--src/network/network.cpp3
-rw-r--r--src/network/network_gamelist.cpp9
-rw-r--r--src/network/network_gui.cpp9
-rw-r--r--src/network/network_server.cpp9
5 files changed, 22 insertions, 11 deletions
diff --git a/src/network/core/packet.h b/src/network/core/packet.h
index 7079b927b..78e36186d 100644
--- a/src/network/core/packet.h
+++ b/src/network/core/packet.h
@@ -34,7 +34,8 @@ typedef uint8 PacketType; ///< Identifier for the packet
struct Packet {
/** The next packet. Used for queueing packets before sending. */
Packet *next;
- /** The size of the whole packet for received packets. For packets
+ /**
+ * The size of the whole packet for received packets. For packets
* that will be sent, the value is filled in just before the
* actual transmission. */
PacketSize size;
diff --git a/src/network/network.cpp b/src/network/network.cpp
index a1cb58a9e..af3fbf855 100644
--- a/src/network/network.cpp
+++ b/src/network/network.cpp
@@ -471,7 +471,8 @@ static void CheckPauseOnJoin()
CheckPauseHelper(NetworkHasJoiningClient(), PM_PAUSED_JOIN);
}
-/** Converts a string to ip/port/company
+/**
+ * Converts a string to ip/port/company
* Format: IP:port#company
*
* connection_string will be re-terminated to seperate out the hostname, and company and port will
diff --git a/src/network/network_gamelist.cpp b/src/network/network_gamelist.cpp
index 97dc0f953..5bb4529f6 100644
--- a/src/network/network_gamelist.cpp
+++ b/src/network/network_gamelist.cpp
@@ -27,7 +27,8 @@ NetworkGameList *_network_game_list = NULL;
static ThreadMutex *_network_game_list_mutex = ThreadMutex::New();
static NetworkGameList *_network_game_delayed_insertion_list = NULL;
-/** Add a new item to the linked gamelist, but do it delayed in the next tick
+/**
+ * Add a new item to the linked gamelist, but do it delayed in the next tick
* or so to prevent race conditions.
* @param item the item to add. Will be freed once added.
*/
@@ -66,7 +67,8 @@ static void NetworkGameListHandleDelayedInsert()
_network_game_list_mutex->EndCritical();
}
-/** Add a new item to the linked gamelist. If the IP and Port match
+/**
+ * Add a new item to the linked gamelist. If the IP and Port match
* return the existing item instead of adding it again
* @param address the address of the to-be added item
* @param port the port the server is running on
@@ -106,7 +108,8 @@ NetworkGameList *NetworkGameListAddItem(NetworkAddress address)
return item;
}
-/** Remove an item from the gamelist linked list
+/**
+ * Remove an item from the gamelist linked list
* @param remove pointer to the item to be removed */
void NetworkGameListRemoveItem(NetworkGameList *remove)
{
diff --git a/src/network/network_gui.cpp b/src/network/network_gui.cpp
index b26947a2c..69dd3b0df 100644
--- a/src/network/network_gui.cpp
+++ b/src/network/network_gui.cpp
@@ -64,7 +64,8 @@ void SortNetworkLanguages()
QSortT(_language_dropdown, NETLANG_COUNT - 1, &StringIDSorter);
}
-/** Update the network new window because a new server is
+/**
+ * Update the network new window because a new server is
* found on the network.
* @param unselect unselect the currently selected item */
void UpdateNetworkGameWindow(bool unselect)
@@ -279,7 +280,8 @@ protected:
return strcasecmp((*a)->info.server_name, (*b)->info.server_name);
}
- /** Sort servers by the amount of clients online on a
+ /**
+ * Sort servers by the amount of clients online on a
* server. If the two servers have the same amount, the one with the
* higher maximum is preferred. */
static int CDECL NGameClientSorter(NetworkGameList * const *a, NetworkGameList * const *b)
@@ -317,7 +319,8 @@ protected:
return (r != 0) ? r : NGameDateSorter(a, b);
}
- /** Sort servers by joinability. If both servers are the
+ /**
+ * Sort servers by joinability. If both servers are the
* same, prefer the non-passworded server first. */
static int CDECL NGameAllowedSorter(NetworkGameList * const *a, NetworkGameList * const *b)
{
diff --git a/src/network/network_server.cpp b/src/network/network_server.cpp
index 13a0a42b2..acbcda234 100644
--- a/src/network/network_server.cpp
+++ b/src/network/network_server.cpp
@@ -884,7 +884,8 @@ DEF_SERVER_RECEIVE_COMMAND(PACKET_CLIENT_MAP_OK)
return SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_NOT_EXPECTED);
}
-/** The client has done a command and wants us to handle it
+/**
+ * The client has done a command and wants us to handle it
* @param *cs the connected client that has sent the command
* @param *p the packet in which the command was sent
*/
@@ -921,7 +922,8 @@ DEF_SERVER_RECEIVE_COMMAND(PACKET_CLIENT_COMMAND)
return SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_KICKED);
}
- /** Only CMD_COMPANY_CTRL is always allowed, for the rest, playas needs
+ /**
+ * Only CMD_COMPANY_CTRL is always allowed, for the rest, playas needs
* to match the company in the packet. If it doesn't, the client has done
* something pretty naughty (or a bug), and will be kicked
*/
@@ -931,7 +933,8 @@ DEF_SERVER_RECEIVE_COMMAND(PACKET_CLIENT_COMMAND)
return SEND_COMMAND(PACKET_SERVER_ERROR)(cs, NETWORK_ERROR_COMPANY_MISMATCH);
}
- /** @todo CMD_COMPANY_CTRL with p1 = 0 announces a new company to the server. To give the
+ /**
+ * @todo CMD_COMPANY_CTRL with p1 = 0 announces a new company to the server. To give the
* company the correct ID, the server injects p2 and executes the command. Any other p1
* is prohibited. Pretty ugly and should be redone together with its function.
* @see CmdCompanyCtrl()