Codechange: Make documentation comments for some functions recognised by doxygen.

This commit is contained in:
Cyprian Klimaszewski
2026-02-20 20:00:43 +01:00
committed by rubidium42
parent 3c8d7df657
commit 2ac0811ff9
13 changed files with 33 additions and 32 deletions
+13 -8
View File
@@ -727,9 +727,10 @@ void GetBindAddresses(NetworkAddressList *addresses, uint16_t port)
}
}
/* Generates the list of manually added hosts from NetworkGame and
* dumps them into the array _network_host_list. This array is needed
* by the function that generates the config file. */
/**
* Generates the list of manually added hosts from NetworkGame and dumps them into the array _network_host_list.
* This array is needed by the function that generates the config file.
*/
void NetworkRebuildHostList()
{
_network_host_list.clear();
@@ -971,8 +972,10 @@ void NetworkOnGameStart()
}
}
/* The server is rebooting...
* The only difference with NetworkDisconnect, is the packets that is sent */
/**
* The server is rebooting...
* The only difference with NetworkDisconnect, is the packets that is sent.
*/
void NetworkReboot()
{
if (_network_server) {
@@ -1060,7 +1063,7 @@ static bool NetworkReceive()
return result;
}
/* This sends all buffered commands (if possible) */
/** This sends all buffered commands (if possible). */
static void NetworkSend()
{
if (_network_server) {
@@ -1089,8 +1092,10 @@ void NetworkBackgroundLoop()
NetworkBackgroundUDPLoop();
}
/* The main loop called from ttd.c
* Here we also have to do StateGameLoop if needed! */
/**
* The main loop called from ttd.c.
* @note Here we also have to do StateGameLoop if needed!
*/
void NetworkGameLoop()
{
if (!_networking) return;