jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-07-06 21:43:55 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Standardize TODO/FIXME comments to Doxygen \todo format

Browse source 
Convert informal TODO and FIXME comments to Doxygen-recognized
      \todo format.

      - // TODO comments → //! \todo ...
      - // FIXME comments → //! \todo ...
      - /** @todo ... */ blocks → //! \todo ...
      - @brief TODO: placeholders → //! \todo (moved outside doc blocks)
This commit is contained in:
DawnFire42 2026-05-13 14:56:02 -04:00
parent f361cd65e0
commit 330ea7b8c6
No known key found for this signature in database
GPG key ID: 24BB855EE2911B33
280 changed files with 300 additions and 300 deletions
Download patch file Download diff file Expand all files Collapse all files

2
libcockatrice_network/libcockatrice/network/client/abstract/abstract_client.h
View file

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

2
libcockatrice_network/libcockatrice/network/client/local/local_client.h
View file

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

4
libcockatrice_network/libcockatrice/network/client/remote/remote_client.cpp
View file

@ -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()) {

2
libcockatrice_network/libcockatrice/network/client/remote/remote_client.h
View file

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