Standardize Doxygen documentation (#6885)

This commit is contained in:
DawnFire42 2026-05-21 16:58:07 -04:00 committed by GitHub
parent 03d54265fe
commit 33e0f8699b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
306 changed files with 539 additions and 487 deletions

View file

@ -261,7 +261,8 @@ void ChatView::appendMessage(QString message,
defaultFormat = QTextCharFormat();
if (!isUserMessage) {
if (messageType == Event_RoomSay::ChatHistory) {
defaultFormat.setForeground(Qt::gray); //! \todo hardcoded color
//! \todo Remove hardcoded color.
defaultFormat.setForeground(Qt::gray);
defaultFormat.setFontWeight(QFont::Light);
defaultFormat.setFontItalic(true);
static const QRegularExpression userNameRegex("^(\\[[^\\]]*\\]\\s)(\\S+):\\s");
@ -284,7 +285,8 @@ void ChatView::appendMessage(QString message,
message.remove(0, pos.relativePosition - 2); // do not remove semicolon
}
} else {
defaultFormat.setForeground(Qt::darkGreen); //! \todo hardcoded color
//! \todo Remove hardcoded color.
defaultFormat.setForeground(Qt::darkGreen);
defaultFormat.setFontWeight(QFont::Bold);
}
}

View file

@ -2,8 +2,8 @@
* @file chat_view.h
* @ingroup NetworkingWidgets
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CHATVIEW_H
#define CHATVIEW_H

View file

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

View file

@ -2,8 +2,8 @@
* @file remote_decklist_tree_widget.h
* @ingroup NetworkingWidgets
* @ingroup DeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef REMOTEDECKLIST_TREEWIDGET_H
#define REMOTEDECKLIST_TREEWIDGET_H

View file

@ -3,8 +3,8 @@
* @ingroup DeckStorageWidgets
* @ingroup Replays
* @ingroup NetworkingWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef REMOTEREPLAYLIST_TREEWIDGET_H
#define REMOTEREPLAYLIST_TREEWIDGET_H

View file

@ -1,8 +1,8 @@
/**
* @file user_context_menu.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef USER_CONTEXT_MENU_H
#define USER_CONTEXT_MENU_H

View file

@ -1,8 +1,8 @@
/**
* @file user_info_box.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef USERINFOBOX_H
#define USERINFOBOX_H

View file

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

View file

@ -1,8 +1,8 @@
/**
* @file user_list_manager.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_USER_LIST_MANAGER_H
#define COCKATRICE_USER_LIST_MANAGER_H

View file

@ -2,8 +2,8 @@
* @file user_list_proxy.h
* @ingroup UI
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_USERLISTPROXY_H
#define COCKATRICE_USERLISTPROXY_H

View file

@ -1,8 +1,8 @@
/**
* @file user_list_widget.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef USERLIST_H
#define USERLIST_H