(svn r7888) -Change: add documentation about the 'on-the-wire' structure of the network game information request and reply packets.

1 files changed, 5 insertions, 0 deletions

diff --git a/src/network/core/udp.c b/src/network/core/udp.c
index 3e23ca962..5e32ad8e4 100644
--- a/src/network/core/udp.c
+++ b/src/network/core/udp.c
@@ -175,6 +175,8 @@ void NetworkSend_NetworkGameInfo(Packet *p, const NetworkGameInfo *info)
 	 * The parts must be read in the same order as they are sent!
 	 */
 
+	/* Update the documentation in udp.h on changes
+	 * to the NetworkGameInfo wire-protocol! */
 
 	/* NETWORK_GAME_INFO_VERSION = 4 */
 	{
@@ -236,6 +238,9 @@ void NetworkRecv_NetworkGameInfo(NetworkClientState *cs, Packet *p, NetworkGameI
 	 * The parts must be read in the same order as they are sent!
 	 */
 
+	/* Update the documentation in udp.h on changes
+	 * to the NetworkGameInfo wire-protocol! */
+
 	switch (info->game_info_version) {
 		case 4: {
 			GRFConfig *c, **dst = &info->grfconfig;