Standardize Doxygen documentation (#6885)

libcockatrice_network/libcockatrice/network/client/abstract/abstract_client.h

@@ -1,8 +1,8 @@
 /**
  * @file abstract_client.h
  * @ingroup Client
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef ABSTRACTCLIENT_H
 #define ABSTRACTCLIENT_H

libcockatrice_network/libcockatrice/network/client/local/local_client.h

@@ -1,8 +1,8 @@
 /**
  * @file local_client.h
  * @ingroup Client
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef LOCALCLIENT_H
 #define LOCALCLIENT_H

libcockatrice_network/libcockatrice/network/client/remote/remote_client.cpp

@@ -224,14 +224,14 @@ Command_Login RemoteClient::generateCommandLogin()
 void RemoteClient::doLogin()
 {
     if (!password.isEmpty() && serverSupportsPasswordHash) {
-        // TODO store and log in using stored hashed password
+        //! \todo Store and log in using stored hashed password.
         if (hashedPassword.isEmpty()) {
             doRequestPasswordSalt(); // ask salt to create hashedPassword, then log in
         } else {
             doHashedLogin(); // log in using hashed password instead
         }
     } else {
-        // TODO add setting for client to reject unhashed logins
+        //! \todo Add setting for client to reject unhashed logins.
         setStatus(StatusLoggingIn);
         Command_Login cmdLogin = generateCommandLogin();
         if (!password.isEmpty()) {

libcockatrice_network/libcockatrice/network/client/remote/remote_client.h

@@ -1,8 +1,8 @@
 /**
  * @file remote_client.h
  * @ingroup Client
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef REMOTECLIENT_H
 #define REMOTECLIENT_H

libcockatrice_network/libcockatrice/network/server/local/local_server.h

@@ -1,8 +1,8 @@
 /**
  * @file local_server.h
  * @ingroup Server
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef LOCALSERVER_H
 #define LOCALSERVER_H

libcockatrice_network/libcockatrice/network/server/local/local_server_interface.h

@@ -1,8 +1,8 @@
 /**
  * @file local_server_interface.h
  * @ingroup Server
- * @brief TODO: Document this.
  */
+//! \todo Document this file.
 
 #ifndef LOCALSERVERINTERFACE_H
 #define LOCALSERVERINTERFACE_H

libcockatrice_network/libcockatrice/network/server/remote/game/server_game.cpp

@@ -334,7 +334,7 @@ void Server_Game::doStartGameIfReady(bool forceStartGame)
         if (!player->getReadyStart()) {
             if (forceStartGame) {
                 // Player is not ready to start, so kick them
-                // TODO: Move them to Spectators instead
+                //! \todo Move them to Spectators instead.
                 kickParticipant(player->getPlayerId());
             } else {
                 return;
@@ -517,7 +517,7 @@ void Server_Game::addPlayer(Server_AbstractUserInterface *userInterface,
         allPlayersEver.insert(playerName);
 
         // if the original creator of the game joins, give them host status back
-        //! \todo transferring host to spectators has side effects
+        //! \todo Transferring host to spectators has side effects.
         if (newParticipant->getUserInfo()->name() == creatorInfo->name()) {
             hostId = newParticipant->getPlayerId();
             sendGameEventContainer(prepareGameEvent(Event_GameHostChanged(), hostId));

libcockatrice_network/libcockatrice/network/server/remote/server.cpp

@@ -286,7 +286,7 @@ QList<QString> Server::getOnlineModeratorList() const
     for (auto &client : clients) {
         ServerInfo_User *data = client->getUserInfo();
 
-        // TODO: this line should be updated in the event there is any type of new user level created
+        //! \todo This line should be updated in the event there is any type of new user level created.
         if (data &&
             (data->user_level() & ServerInfo_User::IsModerator || data->user_level() & ServerInfo_User::IsAdmin)) {
             results << QString::fromStdString(data->name()).simplified();