diff options
30 files changed, 97 insertions, 65 deletions
diff --git a/src/aircraft.h b/src/aircraft.h index 86dec5e17..048e70afe 100644 --- a/src/aircraft.h +++ b/src/aircraft.h @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file aircraft_cmd.h */ +/** @file aircraft.h */ #ifndef AIRCRAFT_H #define AIRCRAFT_H diff --git a/src/network/core/config.h b/src/network/core/config.h index 93145e426..dcc6042de 100644 --- a/src/network/core/config.h +++ b/src/network/core/config.h @@ -1,14 +1,14 @@ /* $Id$ */ +/** + * @file config.h Configuration options of the network stuff + */ + #ifndef NETWORK_CORE_CONFIG_H #define NETWORK_CORE_CONFIG_H #ifdef ENABLE_NETWORK -/** - * @file config.h Configuration options of the network stuff - */ - /** DNS hostname of the masterserver */ #define NETWORK_MASTER_SERVER_HOST "master.openttd.org" /** Message sent to the masterserver to 'identify' this client as OpenTTD */ diff --git a/src/network/core/core.cpp b/src/network/core/core.cpp index 7c187ddcd..7fb10cfaf 100644 --- a/src/network/core/core.cpp +++ b/src/network/core/core.cpp @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file core.cpp Functions used to initialize/shut down the core network + */ + #ifdef ENABLE_NETWORK #include "../../stdafx.h" @@ -8,10 +12,6 @@ #include "core.h" #include "packet.h" -/** - * @file core.cpp Functions used to initialize/shut down the core network - */ - #ifdef __MORPHOS__ /* the library base is required here */ struct Library *SocketBase = NULL; diff --git a/src/network/core/core.h b/src/network/core/core.h index 29c595cd6..990100a69 100644 --- a/src/network/core/core.h +++ b/src/network/core/core.h @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file core.h Base for all network types (UDP and TCP) + */ + #ifndef NETWORK_CORE_H #define NETWORK_CORE_H @@ -8,10 +12,6 @@ #include "os_abstraction.h" #include "../../newgrf_config.h" -/** - * @file core.h Base for all network types (UDP and TCP) - */ - bool NetworkCoreInitialize(void); void NetworkCoreShutdown(void); diff --git a/src/network/core/game.h b/src/network/core/game.h index 6c96527fb..4347fc6b5 100644 --- a/src/network/core/game.h +++ b/src/network/core/game.h @@ -1,5 +1,10 @@ /* $Id$ */ +/** + * @file game.h Information about a game that is sent between a + * game server, game client and masterserver. + */ + #ifndef NETWORK_CORE_GAME_H #define NETWORK_CORE_GAME_H @@ -10,11 +15,6 @@ #include "../../newgrf_config.h" /** - * @file game.h Information about a game that is sent between a - * game server, game client and masterserver. - */ - -/** * This is the struct used by both client and server * some fields will be empty on the client (like game_password) by default * and only filled with data a player enters. diff --git a/src/network/core/os_abstraction.h b/src/network/core/os_abstraction.h index 8c5e4b9d3..dc9f488db 100644 --- a/src/network/core/os_abstraction.h +++ b/src/network/core/os_abstraction.h @@ -1,14 +1,14 @@ /* $Id$ */ -#ifndef NETWORK_CORE_OS_ABSTRACTION_H -#define NETWORK_CORE_OS_ABSTRACTION_H - /** * @file os_abstraction.h Network stuff has many things that needs to be * included and/or implemented by default. * All those things are in this file. */ +#ifndef NETWORK_CORE_OS_ABSTRACTION_H +#define NETWORK_CORE_OS_ABSTRACTION_H + /* Include standard stuff per OS */ #ifdef ENABLE_NETWORK diff --git a/src/network/core/packet.cpp b/src/network/core/packet.cpp index e5f4493ed..e43908d83 100644 --- a/src/network/core/packet.cpp +++ b/src/network/core/packet.cpp @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file packet.cpp Basic functions to create, fill and read packets. + */ + #ifdef ENABLE_NETWORK #include "../../stdafx.h" @@ -9,10 +13,6 @@ #include "packet.h" -/** - * @file packet.cpp Basic functions to create, fill and read packets. - */ - /* Do not want to include functions.h and all required headers */ extern void NORETURN CDECL error(const char *str, ...); diff --git a/src/network/core/packet.h b/src/network/core/packet.h index 50abf7ec1..47fff6247 100644 --- a/src/network/core/packet.h +++ b/src/network/core/packet.h @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file packet.h Basic functions to create, fill and read packets. + */ + #ifndef NETWORK_CORE_PACKET_H #define NETWORK_CORE_PACKET_H @@ -8,10 +12,6 @@ #include "config.h" #include "core.h" -/** - * @file packet.h Basic functions to create, fill and read packets. - */ - typedef uint16 PacketSize; ///< Size of the whole packet. typedef uint8 PacketType; ///< Identifier for the packet diff --git a/src/network/core/tcp.cpp b/src/network/core/tcp.cpp index e27d86946..1520a55f4 100644 --- a/src/network/core/tcp.cpp +++ b/src/network/core/tcp.cpp @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file tcp.cpp Basic functions to receive and send TCP packets. + */ + #ifdef ENABLE_NETWORK #include "../../stdafx.h" @@ -14,10 +18,6 @@ #include "tcp.h" #include "../../helpers.hpp" -/** - * @file tcp.cpp Basic functions to receive and send TCP packets. - */ - /** Very ugly temporary hack !!! */ void NetworkTCPSocketHandler::Initialize() { diff --git a/src/network/core/tcp.h b/src/network/core/tcp.h index b7150a447..27df6e03d 100644 --- a/src/network/core/tcp.h +++ b/src/network/core/tcp.h @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file tcp.h Basic functions to receive and send TCP packets. + */ + #ifndef NETWORK_CORE_TCP_H #define NETWORK_CORE_TCP_H @@ -10,10 +14,6 @@ #include "packet.h" /** - * @file tcp.h Basic functions to receive and send TCP packets. - */ - -/** * Enum with all types of UDP packets. * The order of the first 4 packets MUST not be changed, as * it protects old clients from joining newer servers diff --git a/src/network/core/udp.cpp b/src/network/core/udp.cpp index 45ed287c1..d58184489 100644 --- a/src/network/core/udp.cpp +++ b/src/network/core/udp.cpp @@ -1,5 +1,9 @@ /* $Id$ */ +/** + * @file core/udp.cpp Basic functions to receive and send UDP packets. + */ + #ifdef ENABLE_NETWORK #include "../../stdafx.h" @@ -10,10 +14,6 @@ #include "udp.h" /** - * @file core/udp.cpp Basic functions to receive and send UDP packets. - */ - -/** * Start listening on the given host and port. * @param host the host (ip) to listen on * @param port the port to listen on diff --git a/src/network/core/udp.h b/src/network/core/udp.h index bddbba9ba..3696bada4 100644 --- a/src/network/core/udp.h +++ b/src/network/core/udp.h @@ -1,16 +1,5 @@ /* $Id$ */ -#ifndef NETWORK_CORE_UDP_H -#define NETWORK_CORE_UDP_H - -#ifdef ENABLE_NETWORK - -#include "os_abstraction.h" -#include "core.h" -#include "game.h" -#include "packet.h" -#include "../../debug.h" - /** * @file udp.h Basic functions to receive and send UDP packets. * @@ -72,6 +61,17 @@ * 1+ 1 whether the server is dedicated (0 = no, 1 = yes) */ +#ifndef NETWORK_CORE_UDP_H +#define NETWORK_CORE_UDP_H + +#ifdef ENABLE_NETWORK + +#include "os_abstraction.h" +#include "core.h" +#include "game.h" +#include "packet.h" +#include "../../debug.h" + /** Enum with all types of UDP packets. The order MUST not be changed **/ enum PacketUDPType { PACKET_UDP_CLIENT_FIND_SERVER, ///< Queries a game server for game information diff --git a/src/network/network_gamelist.cpp b/src/network/network_gamelist.cpp index c4b51c230..4bd5d10b0 100644 --- a/src/network/network_gamelist.cpp +++ b/src/network/network_gamelist.cpp @@ -1,5 +1,10 @@ /* $Id$ */ +/** + * @file network_gamelist.cpp This file handles the GameList + * Also, it handles the request to a server for data about the server + */ + #ifdef ENABLE_NETWORK #include "../stdafx.h" @@ -11,11 +16,6 @@ #include "network_gamelist.h" #include "network_gui.h" -/** - * @file network_gamelist.cpp This file handles the GameList - * Also, it handles the request to a server for data about the server - */ - NetworkGameList *_network_game_list = NULL; /** Should we stop/contiue requerying of offline servers? */ diff --git a/src/network/network_udp.cpp b/src/network/network_udp.cpp index 81f93d32d..9bf7f344c 100644 --- a/src/network/network_udp.cpp +++ b/src/network/network_udp.cpp @@ -1,5 +1,12 @@ /* $Id$ */ +/** + * @file network_udp.cpp This file handles the UDP related communication. + * + * This is the GameServer <-> MasterServer and GameServer <-> GameClient + * communication before the game is being joined. + */ + #ifdef ENABLE_NETWORK #include "../stdafx.h" @@ -15,13 +22,6 @@ #include "core/udp.h" -/** - * @file network_udp.c This file handles the UDP related communication. - * - * This is the GameServer <-> MasterServer and GameServer <-> GameClient - * communication before the game is being joined. - */ - enum { ADVERTISE_NORMAL_INTERVAL = 30000, // interval between advertising in ticks (15 minutes) ADVERTISE_RETRY_INTERVAL = 300, // readvertise when no response after this many ticks (9 seconds) diff --git a/src/station.cpp b/src/station.cpp index 5e658f303..2338dfbbf 100644 --- a/src/station.cpp +++ b/src/station.cpp @@ -1,6 +1,6 @@ /* $Id$ */ -/** @file station_cmd.cpp */ +/** @file station.cpp */ #include "stdafx.h" #include "openttd.h" diff --git a/src/yapf/follow_track.hpp b/src/yapf/follow_track.hpp index afae9b788..99c6ea20e 100644 --- a/src/yapf/follow_track.hpp +++ b/src/yapf/follow_track.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file follow_track.hpp Template function for track followers */ + #ifndef FOLLOW_TRACK_HPP #define FOLLOW_TRACK_HPP diff --git a/src/yapf/nodelist.hpp b/src/yapf/nodelist.hpp index a4d14e934..000c36659 100644 --- a/src/yapf/nodelist.hpp +++ b/src/yapf/nodelist.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file nodelist.hpp */ + #ifndef NODELIST_HPP #define NODELIST_HPP diff --git a/src/yapf/yapf.h b/src/yapf/yapf.h index 76f2dc1cb..132922b11 100644 --- a/src/yapf/yapf.h +++ b/src/yapf/yapf.h @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf.h */ + #ifndef YAPF_H #define YAPF_H diff --git a/src/yapf/yapf_base.hpp b/src/yapf/yapf_base.hpp index 3dfa9e908..6218c6ec7 100644 --- a/src/yapf/yapf_base.hpp +++ b/src/yapf/yapf_base.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_base.hpp */ + #ifndef YAPF_BASE_HPP #define YAPF_BASE_HPP diff --git a/src/yapf/yapf_common.hpp b/src/yapf/yapf_common.hpp index 87deffeda..ed6b8782a 100644 --- a/src/yapf/yapf_common.hpp +++ b/src/yapf/yapf_common.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_common.hpp */ + #ifndef YAPF_COMMON_HPP #define YAPF_COMMON_HPP diff --git a/src/yapf/yapf_costcache.hpp b/src/yapf/yapf_costcache.hpp index c90d37302..5b459601a 100644 --- a/src/yapf/yapf_costcache.hpp +++ b/src/yapf/yapf_costcache.hpp @@ -1,4 +1,7 @@ /* $Id$ */ + +/** @file yapf_costcache.hpp */ + #ifndef YAPF_COSTCACHE_HPP #define YAPF_COSTCACHE_HPP diff --git a/src/yapf/yapf_costrail.hpp b/src/yapf/yapf_costrail.hpp index e1fd61068..b776815dc 100644 --- a/src/yapf/yapf_costrail.hpp +++ b/src/yapf/yapf_costrail.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_costrail.hpp */ + #ifndef YAPF_COSTRAIL_HPP #define YAPF_COSTRAIL_HPP diff --git a/src/yapf/yapf_destrail.hpp b/src/yapf/yapf_destrail.hpp index 9a5bd0536..1baa62164 100644 --- a/src/yapf/yapf_destrail.hpp +++ b/src/yapf/yapf_destrail.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_destrail.hpp */ + #ifndef YAPF_DESTRAIL_HPP #define YAPF_DESTRAIL_HPP diff --git a/src/yapf/yapf_node.hpp b/src/yapf/yapf_node.hpp index 2fa82a6a6..577a40b7d 100644 --- a/src/yapf/yapf_node.hpp +++ b/src/yapf/yapf_node.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_node.hpp */ + #ifndef YAPF_NODE_HPP #define YAPF_NODE_HPP diff --git a/src/yapf/yapf_node_rail.hpp b/src/yapf/yapf_node_rail.hpp index df0186989..549bf76b7 100644 --- a/src/yapf/yapf_node_rail.hpp +++ b/src/yapf/yapf_node_rail.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_node_rail.hpp */ + #ifndef YAPF_NODE_RAIL_HPP #define YAPF_NODE_RAIL_HPP diff --git a/src/yapf/yapf_node_road.hpp b/src/yapf/yapf_node_road.hpp index dc6f1be3a..ff4856c8d 100644 --- a/src/yapf/yapf_node_road.hpp +++ b/src/yapf/yapf_node_road.hpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_node_road.hpp */ + #ifndef YAPF_NODE_ROAD_HPP #define YAPF_NODE_ROAD_HPP diff --git a/src/yapf/yapf_rail.cpp b/src/yapf/yapf_rail.cpp index 5073b8705..8b88fde26 100644 --- a/src/yapf/yapf_rail.cpp +++ b/src/yapf/yapf_rail.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_rail.cpp */ + #include "../stdafx.h" #include "yapf.hpp" diff --git a/src/yapf/yapf_road.cpp b/src/yapf/yapf_road.cpp index 43d98716d..763d39af4 100644 --- a/src/yapf/yapf_road.cpp +++ b/src/yapf/yapf_road.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_road.cpp */ + #include "../stdafx.h" #include "yapf.hpp" diff --git a/src/yapf/yapf_settings.h b/src/yapf/yapf_settings.h index f66b4b732..aea509441 100644 --- a/src/yapf/yapf_settings.h +++ b/src/yapf/yapf_settings.h @@ -1,4 +1,7 @@ /* $Id$ */ + +/** @file yapf_settings.h */ + #if !defined(YAPF_SETTINGS_H) || defined(YS_DEF) # ifndef YAPF_SETTINGS_H diff --git a/src/yapf/yapf_ship.cpp b/src/yapf/yapf_ship.cpp index 038bdba43..43f7eca73 100644 --- a/src/yapf/yapf_ship.cpp +++ b/src/yapf/yapf_ship.cpp @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file yapf_ship.cpp */ + #include "../stdafx.h" #include "yapf.hpp" |