From 33e0f8699b373d222a80d5403eacac7cbb73cf42 Mon Sep 17 00:00:00 2001 From: DawnFire42 Date: Thu, 21 May 2026 16:58:07 -0400 Subject: [PATCH] Standardize Doxygen documentation (#6885) --- .github/CONTRIBUTING.md | 10 +++ .../network/interfaces/deck_stats_interface.h | 2 +- .../network/interfaces/tapped_out_interface.h | 2 +- .../parsers/deck_link_to_api_transformer.h | 2 +- .../parsers/interface_json_deck_parser.h | 2 +- .../card_spoiler/spoiler_background_updater.h | 2 +- .../update/client/client_update_checker.h | 2 +- .../network/update/client/release_channel.h | 2 +- .../network/update/client/update_downloader.h | 2 +- .../src/client/settings/cache_settings.h | 2 +- .../client/settings/card_counter_settings.h | 2 +- .../src/client/settings/shortcut_treeview.h | 2 +- .../client/settings/shortcuts_settings.cpp | 13 ++-- .../src/client/settings/shortcuts_settings.h | 2 +- cockatrice/src/client/sound_engine.h | 2 +- cockatrice/src/filters/deck_filter_string.h | 2 +- cockatrice/src/filters/filter_builder.h | 2 +- cockatrice/src/filters/filter_tree_model.h | 2 +- cockatrice/src/filters/syntax_help.h | 2 +- cockatrice/src/game/abstract_game.h | 2 +- .../src/game/board/abstract_card_drag_item.h | 2 +- cockatrice/src/game/board/abstract_counter.h | 2 +- cockatrice/src/game/board/arrow_item.h | 2 +- cockatrice/src/game/board/arrow_target.h | 2 +- cockatrice/src/game/board/card_drag_item.h | 2 +- cockatrice/src/game/board/card_item.h | 2 +- cockatrice/src/game/board/card_list.h | 2 +- cockatrice/src/game/board/counter_general.h | 2 +- .../src/game/board/translate_counter_name.h | 2 +- cockatrice/src/game/card_dimensions.h | 8 +-- cockatrice/src/game/deckview/deck_view.h | 2 +- .../src/game/deckview/deck_view_container.h | 2 +- .../deckview/tabbed_deck_view_container.h | 2 +- .../src/game/dialogs/dlg_create_token.h | 2 +- .../game/dialogs/dlg_move_top_cards_until.h | 2 +- cockatrice/src/game/dialogs/dlg_roll_dice.h | 2 +- cockatrice/src/game/game.h | 2 +- cockatrice/src/game/game_event_handler.h | 2 +- cockatrice/src/game/game_meta_info.h | 2 +- cockatrice/src/game/game_scene.h | 40 +++++------ cockatrice/src/game/game_state.h | 2 +- cockatrice/src/game/game_view.h | 2 +- cockatrice/src/game/hand_counter.h | 2 +- cockatrice/src/game/log/message_log_widget.h | 2 +- cockatrice/src/game/phase.h | 2 +- cockatrice/src/game/phases_toolbar.h | 2 +- .../src/game/player/card_menu_action_type.h | 2 +- .../game/player/event_processing_options.h | 2 +- .../player/menu/abstract_player_component.h | 6 +- cockatrice/src/game/player/menu/card_menu.h | 2 +- .../src/game/player/menu/custom_zone_menu.h | 2 +- cockatrice/src/game/player/menu/grave_menu.h | 2 +- cockatrice/src/game/player/menu/hand_menu.h | 2 +- .../src/game/player/menu/library_menu.h | 2 +- cockatrice/src/game/player/menu/move_menu.h | 2 +- cockatrice/src/game/player/menu/player_menu.h | 14 ++-- cockatrice/src/game/player/menu/pt_menu.h | 2 +- cockatrice/src/game/player/menu/rfg_menu.h | 2 +- cockatrice/src/game/player/menu/say_menu.h | 2 +- .../src/game/player/menu/sideboard_menu.h | 2 +- .../src/game/player/menu/utility_menu.h | 2 +- cockatrice/src/game/player/player_actions.h | 2 +- cockatrice/src/game/player/player_area.h | 2 +- .../src/game/player/player_event_handler.h | 2 +- .../src/game/player/player_graphics_item.h | 2 +- cockatrice/src/game/player/player_info.h | 2 +- .../src/game/player/player_list_widget.h | 2 +- cockatrice/src/game/player/player_logic.h | 2 +- cockatrice/src/game/player/player_manager.h | 2 +- cockatrice/src/game/player/player_target.h | 2 +- cockatrice/src/game/replay.h | 2 +- cockatrice/src/game/z_value_layer_manager.h | 9 +-- cockatrice/src/game/zones/card_zone_logic.h | 2 +- cockatrice/src/game/zones/hand_zone_logic.h | 2 +- cockatrice/src/game/zones/pile_zone_logic.h | 2 +- cockatrice/src/game/zones/stack_zone_logic.h | 2 +- cockatrice/src/game/zones/table_zone_logic.h | 2 +- cockatrice/src/game/zones/view_zone_logic.h | 2 +- .../board/abstract_graphics_item.h | 2 +- .../game_graphics/board/graphics_item_type.h | 2 +- .../src/game_graphics/zones/card_zone.h | 9 ++- .../src/game_graphics/zones/pile_zone.h | 2 +- .../src/game_graphics/zones/select_zone.h | 68 ++++++++++++------- .../src/game_graphics/zones/stack_zone.h | 2 +- .../src/game_graphics/zones/table_zone.h | 11 ++- .../src/game_graphics/zones/view_zone.h | 2 +- .../game_graphics/zones/view_zone_widget.h | 2 +- .../card_picture_to_load.cpp | 2 +- .../src/interface/deck_loader/deck_loader.h | 2 +- cockatrice/src/interface/key_signals.h | 2 +- .../src/interface/layouts/flow_layout.h | 1 + .../src/interface/layouts/overlap_layout.cpp | 2 +- .../src/interface/layouts/overlap_layout.h | 2 +- cockatrice/src/interface/logger.h | 2 +- .../src/interface/pixel_map_generator.h | 2 +- cockatrice/src/interface/theme_manager.cpp | 2 +- cockatrice/src/interface/theme_manager.h | 2 +- .../additional_info/color_identity_widget.h | 2 +- .../cards/additional_info/mana_cost_widget.h | 2 +- .../additional_info/mana_symbol_widget.h | 2 +- .../card_group_display_widget.h | 2 +- .../flat_card_group_display_widget.h | 2 +- .../overlapped_card_group_display_widget.h | 2 +- .../widgets/cards/card_info_display_widget.h | 2 +- .../widgets/cards/card_info_frame_widget.h | 2 +- .../cards/card_info_picture_art_crop_widget.h | 2 +- .../cards/card_info_picture_enlarged_widget.h | 2 +- .../widgets/cards/card_info_picture_widget.h | 2 +- ...rd_info_picture_with_text_overlay_widget.h | 2 +- .../widgets/cards/card_info_text_widget.h | 2 +- .../widgets/cards/card_size_widget.h | 2 +- .../cards/deck_card_zone_display_widget.h | 2 +- .../cards/deck_preview_card_picture_widget.h | 2 +- .../mana_base/mana_base_widget.h | 2 +- .../mana_curve/mana_curve_widget.h | 4 +- .../mana_devotion/mana_devotion_widget.h | 2 +- .../deck_editor_deck_dock_widget.cpp | 14 ++-- .../widgets/deck_editor/deck_state_manager.h | 8 ++- .../interface/widgets/dialogs/dlg_connect.h | 2 +- .../dialogs/dlg_convert_deck_to_cod_format.h | 2 +- .../widgets/dialogs/dlg_create_game.h | 2 +- .../widgets/dialogs/dlg_default_tags_editor.h | 2 +- .../widgets/dialogs/dlg_edit_avatar.h | 2 +- .../widgets/dialogs/dlg_edit_password.cpp | 2 +- .../widgets/dialogs/dlg_edit_password.h | 2 +- .../widgets/dialogs/dlg_edit_tokens.h | 2 +- .../interface/widgets/dialogs/dlg_edit_user.h | 2 +- .../widgets/dialogs/dlg_filter_games.h | 2 +- .../dialogs/dlg_forgot_password_challenge.h | 2 +- .../dialogs/dlg_forgot_password_request.h | 2 +- .../dialogs/dlg_forgot_password_reset.cpp | 2 +- .../dialogs/dlg_forgot_password_reset.h | 2 +- .../interface/widgets/dialogs/dlg_load_deck.h | 2 +- .../dialogs/dlg_load_deck_from_clipboard.h | 2 +- .../dialogs/dlg_load_deck_from_website.h | 2 +- .../widgets/dialogs/dlg_load_remote_deck.h | 2 +- .../widgets/dialogs/dlg_manage_sets.h | 2 +- .../widgets/dialogs/dlg_register.cpp | 2 +- .../interface/widgets/dialogs/dlg_register.h | 2 +- .../dialogs/dlg_select_set_for_cards.h | 2 +- .../widgets/dialogs/dlg_settings.cpp | 4 +- .../interface/widgets/dialogs/dlg_settings.h | 2 +- .../widgets/dialogs/dlg_startup_card_check.h | 2 +- .../widgets/dialogs/dlg_tip_of_the_day.h | 2 +- .../interface/widgets/dialogs/dlg_update.cpp | 2 +- .../interface/widgets/dialogs/dlg_update.h | 2 +- .../interface/widgets/dialogs/dlg_view_log.h | 2 +- .../widgets/dialogs/tip_of_the_day.h | 2 +- .../widgets/general/background_sources.h | 2 +- .../widgets/general/display/banner_widget.h | 2 +- .../general/display/charts/bars/bar_widget.h | 2 +- .../general/display/charts/bars/color_bar.h | 6 +- .../display/charts/bars/percent_bar_widget.h | 2 +- .../general/display/dynamic_font_size_label.h | 2 +- .../display/dynamic_font_size_push_button.h | 2 +- .../widgets/general/display/labeled_input.h | 2 +- .../general/display/shadow_background_label.h | 2 +- .../widgets/general/home_styled_button.h | 2 +- .../interface/widgets/general/home_widget.h | 2 +- .../general/layout_containers/flow_widget.h | 1 + .../overlap_control_widget.cpp | 2 +- .../overlap_control_widget.h | 2 +- .../layout_containers/overlap_widget.h | 2 +- .../widgets/menus/deck_editor_menu.h | 2 +- .../interface/widgets/menus/tearoff_menu.h | 2 +- .../all_zones_card_amount_widget.h | 2 +- .../printing_selector/card_amount_widget.h | 2 +- .../printing_selector/printing_selector.h | 2 +- .../printing_selector_card_display_widget.h | 2 +- .../printing_selector_card_overlay_widget.h | 2 +- .../printing_selector_card_search_widget.h | 2 +- .../printing_selector_card_selection_widget.h | 2 +- .../printing_selector_card_sorting_widget.h | 2 +- ...ame_and_collectors_number_display_widget.h | 2 +- .../quick_settings/settings_button_widget.h | 4 +- .../quick_settings/settings_popup_widget.h | 2 +- .../interface/widgets/replay/replay_manager.h | 2 +- .../widgets/replay/replay_timeline_widget.cpp | 10 ++- .../widgets/replay/replay_timeline_widget.h | 2 +- .../widgets/server/chat_view/chat_view.cpp | 6 +- .../widgets/server/chat_view/chat_view.h | 2 +- .../widgets/server/handle_public_servers.h | 2 +- .../remote/remote_decklist_tree_widget.h | 2 +- .../remote/remote_replay_list_tree_widget.h | 2 +- .../widgets/server/user/user_context_menu.h | 2 +- .../widgets/server/user/user_info_box.h | 2 +- .../server/user/user_info_connection.h | 2 +- .../widgets/server/user/user_list_manager.h | 2 +- .../widgets/server/user/user_list_proxy.h | 2 +- .../widgets/server/user/user_list_widget.h | 2 +- .../card/archidekt_api_response_card.cpp | 10 +-- .../deck/archidekt_api_response_deck.cpp | 2 +- ...kt_api_response_deck_listing_container.cpp | 2 +- .../archidekt_api_response_deck_owner.cpp | 2 +- ...pi_response_deck_listings_display_widget.h | 8 +-- .../average_deck/edhrec_deck_api_response.h | 2 +- .../edhrec_api_response_card_prices.h | 2 +- .../edhrec_api_response_card_container.h | 2 +- .../cards/edhrec_api_response_card_details.h | 2 +- .../cards/edhrec_api_response_card_list.h | 2 +- ...commander_api_response_commander_details.h | 2 +- .../top_cards/edhrec_top_cards_api_response.h | 2 +- .../edhrec_top_commanders_api_response.h | 2 +- .../top_tags/edhrec_top_tags_api_response.h | 2 +- ..._api_response_card_prices_display_widget.h | 2 +- ...api_response_card_details_display_widget.h | 2 +- ...i_response_card_inclusion_display_widget.h | 2 +- ...ec_api_response_card_list_display_widget.h | 2 +- ...api_response_card_synergy_display_widget.h | 2 +- ...esponse_commander_details_display_widget.h | 2 +- ...ec_commander_api_response_display_widget.h | 2 +- ...commander_api_response_navigation_widget.h | 2 +- ...ec_top_cards_api_response_display_widget.h | 2 +- ...p_commanders_api_response_display_widget.h | 2 +- ...rec_top_tags_api_response_display_widget.h | 2 +- .../widgets/tabs/api/edhrec/tab_edhrec.h | 2 +- .../widgets/tabs/api/edhrec/tab_edhrec_main.h | 2 +- cockatrice/src/interface/widgets/tabs/tab.h | 2 +- .../src/interface/widgets/tabs/tab_account.h | 2 +- .../src/interface/widgets/tabs/tab_admin.h | 2 +- .../interface/widgets/tabs/tab_deck_storage.h | 2 +- .../src/interface/widgets/tabs/tab_game.h | 2 +- .../src/interface/widgets/tabs/tab_home.h | 2 +- .../src/interface/widgets/tabs/tab_logs.h | 2 +- .../src/interface/widgets/tabs/tab_message.h | 2 +- .../src/interface/widgets/tabs/tab_replays.h | 2 +- .../src/interface/widgets/tabs/tab_room.h | 2 +- .../src/interface/widgets/tabs/tab_server.h | 2 +- .../interface/widgets/tabs/tab_supervisor.h | 2 +- .../tabs/tab_visual_database_display.h | 2 +- .../tab_deck_editor_visual_tab_widget.h | 10 +-- .../tab_deck_storage_visual.h | 2 +- .../widgets/utility/custom_line_edit.h | 2 +- .../widgets/utility/line_edit_completer.h | 2 +- .../interface/widgets/utility/sequence_edit.h | 2 +- ...ual_database_display_color_filter_widget.h | 2 +- ...database_display_filter_save_load_widget.h | 2 +- ...database_display_main_type_filter_widget.h | 2 +- ...sual_database_display_name_filter_widget.h | 2 +- ...isual_database_display_set_filter_widget.h | 2 +- ..._database_display_sub_type_filter_widget.h | 2 +- .../visual_database_display_widget.h | 2 +- .../visual_database_filter_display_widget.h | 2 +- .../visual_deck_display_options_widget.h | 22 +++--- .../visual_deck_editor_sample_hand_widget.h | 2 +- .../visual_deck_editor_widget.cpp | 4 +- .../visual_deck_editor_widget.h | 2 +- ...eck_preview_color_identity_filter_widget.h | 2 +- .../deck_preview_deck_tags_display_widget.h | 2 +- .../deck_preview_tag_addition_widget.h | 2 +- .../deck_preview/deck_preview_tag_dialog.h | 2 +- .../deck_preview_tag_display_widget.h | 2 +- .../deck_preview_tag_item_widget.h | 2 +- .../deck_preview/deck_preview_widget.cpp | 4 +- .../deck_preview/deck_preview_widget.h | 2 +- ...isual_deck_storage_folder_display_widget.h | 2 +- .../visual_deck_storage_search_widget.h | 2 +- .../visual_deck_storage_sort_widget.h | 2 +- .../visual_deck_storage_tag_filter_widget.h | 2 +- .../visual_deck_storage_widget.h | 2 +- cockatrice/src/interface/window_main.h | 2 +- cockatrice/src/main.h | 2 +- .../libcockatrice/card/card_info_comparator.h | 2 +- .../card/database/card_database.h | 18 ++--- .../card/database/card_database_manager.h | 6 +- .../libcockatrice/card/game_specific_terms.h | 2 +- .../libcockatrice/card/set/card_set.h | 16 ++--- .../card/set/card_set_comparator.h | 2 +- .../libcockatrice/deck_list/deck_list.h | 24 ++++--- .../deck_list/deck_list_node_tree.h | 6 +- .../libcockatrice/deck_list/sideboard_plan.h | 6 +- .../tree/abstract_deck_list_card_node.h | 24 +++---- .../deck_list/tree/abstract_deck_list_node.h | 4 +- .../deck_list/tree/deck_list_card_node.h | 26 +++---- .../deck_list/tree/inner_deck_list_node.h | 22 +++--- .../libcockatrice/filters/filter_card.h | 2 +- .../libcockatrice/filters/filter_string.h | 2 +- .../libcockatrice/filters/filter_tree.h | 17 +++-- .../card/card_completer_proxy_model.h | 2 +- .../models/database/card/card_search_model.h | 2 +- .../database/card_set/card_sets_model.h | 2 +- .../database/token/token_display_model.h | 2 +- .../models/database/token/token_edit_model.h | 2 +- .../models/deck_list/deck_list_model.cpp | 11 +-- .../deck_list_sort_filter_proxy_model.h | 2 +- .../network/client/abstract/abstract_client.h | 2 +- .../network/client/local/local_client.h | 2 +- .../network/client/remote/remote_client.cpp | 4 +- .../network/client/remote/remote_client.h | 2 +- .../network/server/local/local_server.h | 2 +- .../server/local/local_server_interface.h | 2 +- .../server/remote/game/server_game.cpp | 4 +- .../network/server/remote/server.cpp | 2 +- .../libcockatrice/protocol/pending_command.h | 2 +- .../settings/card_database_settings.h | 2 +- .../settings/card_override_settings.h | 2 +- .../libcockatrice/settings/debug_settings.h | 2 +- .../settings/download_settings.h | 2 +- .../settings/game_filters_settings.h | 2 +- .../libcockatrice/settings/layouts_settings.h | 2 +- .../libcockatrice/settings/message_settings.h | 2 +- .../libcockatrice/settings/recents_settings.h | 2 +- .../libcockatrice/settings/servers_settings.h | 2 +- .../libcockatrice/settings/settings_manager.h | 2 +- .../libcockatrice/utility/levenshtein.h | 2 +- servatrice/src/serversocketinterface.cpp | 4 +- 306 files changed, 539 insertions(+), 487 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b293b3937..56ad64283 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -209,6 +209,16 @@ nowadays and clean it up for you. Lines should be 120 characters or less. Please break up lines that are too long into smaller parts, for example at spaces or after opening a brace. +### Documentation Comments ### + +Use [Doxygen](https://www.doxygen.nl/) for code documentation: + +- **Doc blocks**: Use `/** @brief Description */` (Javadoc-style), not `///` +- **Member comments**: Use trailing `///<` for inline member documentation +- **TODOs**: Use `//! \todo Description` (Qt-style), Doxygen collects them into a Todo List + (uses [Qt-style comments](https://www.doxygen.nl/manual/docblocks.html) with + Doxygen's [\todo command](https://www.doxygen.nl/manual/commands.html#cmdtodo)) + ### Memory Management ### New code should be written using references over pointers and stack allocation diff --git a/cockatrice/src/client/network/interfaces/deck_stats_interface.h b/cockatrice/src/client/network/interfaces/deck_stats_interface.h index 7dc841027..2ec67a5a7 100644 --- a/cockatrice/src/client/network/interfaces/deck_stats_interface.h +++ b/cockatrice/src/client/network/interfaces/deck_stats_interface.h @@ -1,8 +1,8 @@ /** * @file deck_stats_interface.h * @ingroup ApiInterfaces - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECKSTATS_INTERFACE_H #define DECKSTATS_INTERFACE_H diff --git a/cockatrice/src/client/network/interfaces/tapped_out_interface.h b/cockatrice/src/client/network/interfaces/tapped_out_interface.h index 0ea9c8358..f1cc1cbeb 100644 --- a/cockatrice/src/client/network/interfaces/tapped_out_interface.h +++ b/cockatrice/src/client/network/interfaces/tapped_out_interface.h @@ -1,8 +1,8 @@ /** * @file tapped_out_interface.h * @ingroup ApiInterfaces - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAPPEDOUT_INTERFACE_H #define TAPPEDOUT_INTERFACE_H diff --git a/cockatrice/src/client/network/parsers/deck_link_to_api_transformer.h b/cockatrice/src/client/network/parsers/deck_link_to_api_transformer.h index 1e2372fd1..bbdd70c97 100644 --- a/cockatrice/src/client/network/parsers/deck_link_to_api_transformer.h +++ b/cockatrice/src/client/network/parsers/deck_link_to_api_transformer.h @@ -1,8 +1,8 @@ /** * @file deck_link_to_api_transformer.h * @ingroup ApiInterfaces - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_LINK_TO_API_TRANSFORMER_H #define DECK_LINK_TO_API_TRANSFORMER_H diff --git a/cockatrice/src/client/network/parsers/interface_json_deck_parser.h b/cockatrice/src/client/network/parsers/interface_json_deck_parser.h index 1818aa35c..87fde4d54 100644 --- a/cockatrice/src/client/network/parsers/interface_json_deck_parser.h +++ b/cockatrice/src/client/network/parsers/interface_json_deck_parser.h @@ -1,8 +1,8 @@ /** * @file interface_json_deck_parser.h * @ingroup ApiInterfaces - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef INTERFACE_JSON_DECK_PARSER_H #define INTERFACE_JSON_DECK_PARSER_H diff --git a/cockatrice/src/client/network/update/card_spoiler/spoiler_background_updater.h b/cockatrice/src/client/network/update/card_spoiler/spoiler_background_updater.h index a2feb5ccf..03d4897a2 100644 --- a/cockatrice/src/client/network/update/card_spoiler/spoiler_background_updater.h +++ b/cockatrice/src/client/network/update/card_spoiler/spoiler_background_updater.h @@ -1,8 +1,8 @@ /** * @file spoiler_background_updater.h * @ingroup Client - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_SPOILER_DOWNLOADER_H #define COCKATRICE_SPOILER_DOWNLOADER_H diff --git a/cockatrice/src/client/network/update/client/client_update_checker.h b/cockatrice/src/client/network/update/client/client_update_checker.h index 4e6f279c3..1a89de533 100644 --- a/cockatrice/src/client/network/update/client/client_update_checker.h +++ b/cockatrice/src/client/network/update/client/client_update_checker.h @@ -1,8 +1,8 @@ /** * @file client_update_checker.h * @ingroup ClientUpdate - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CLIENT_UPDATE_CHECKER_H #define CLIENT_UPDATE_CHECKER_H diff --git a/cockatrice/src/client/network/update/client/release_channel.h b/cockatrice/src/client/network/update/client/release_channel.h index 93e6b985d..c56d0cfce 100644 --- a/cockatrice/src/client/network/update/client/release_channel.h +++ b/cockatrice/src/client/network/update/client/release_channel.h @@ -1,8 +1,8 @@ /** * @file release_channel.h * @ingroup ClientUpdate - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef RELEASECHANNEL_H #define RELEASECHANNEL_H diff --git a/cockatrice/src/client/network/update/client/update_downloader.h b/cockatrice/src/client/network/update/client/update_downloader.h index d70759038..9a0caccbc 100644 --- a/cockatrice/src/client/network/update/client/update_downloader.h +++ b/cockatrice/src/client/network/update/client/update_downloader.h @@ -1,8 +1,8 @@ /** * @file update_downloader.h * @ingroup ClientUpdate - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_UPDATEDOWNLOADER_H #define COCKATRICE_UPDATEDOWNLOADER_H diff --git a/cockatrice/src/client/settings/cache_settings.h b/cockatrice/src/client/settings/cache_settings.h index 90aa8eedb..b1197e267 100644 --- a/cockatrice/src/client/settings/cache_settings.h +++ b/cockatrice/src/client/settings/cache_settings.h @@ -1,8 +1,8 @@ /** * @file cache_settings.h * @ingroup Settings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SETTINGSCACHE_H #define SETTINGSCACHE_H diff --git a/cockatrice/src/client/settings/card_counter_settings.h b/cockatrice/src/client/settings/card_counter_settings.h index b1d467d67..2ac658177 100644 --- a/cockatrice/src/client/settings/card_counter_settings.h +++ b/cockatrice/src/client/settings/card_counter_settings.h @@ -1,8 +1,8 @@ /** * @file card_counter_settings.h * @ingroup GameSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_COUNTER_SETTINGS_H #define CARD_COUNTER_SETTINGS_H diff --git a/cockatrice/src/client/settings/shortcut_treeview.h b/cockatrice/src/client/settings/shortcut_treeview.h index 8d74a6f1e..afaf7e7ed 100644 --- a/cockatrice/src/client/settings/shortcut_treeview.h +++ b/cockatrice/src/client/settings/shortcut_treeview.h @@ -1,8 +1,8 @@ /** * @file shortcut_treeview.h * @ingroup CoreSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SHORTCUT_TREEVIEW_H #define SHORTCUT_TREEVIEW_H diff --git a/cockatrice/src/client/settings/shortcuts_settings.cpp b/cockatrice/src/client/settings/shortcuts_settings.cpp index 53c6f6a23..2ff65ab6f 100644 --- a/cockatrice/src/client/settings/shortcuts_settings.cpp +++ b/cockatrice/src/client/settings/shortcuts_settings.cpp @@ -64,8 +64,13 @@ ShortcutsSettings::ShortcutsSettings(const QString &settingsPath, QObject *paren } } -/// PR 5079 changes Textbox/unfocusTextBox to Player/unfocusTextBox and tab_game/aFocusChat to Player/aFocusChat. -/// A migration is necessary to let players keep their already configured shortcuts. +/** + * @brief Migrates legacy shortcut key names to current naming scheme. + * + * PR 5079 changed Textbox/unfocusTextBox to Player/unfocusTextBox and + * tab_game/aFocusChat to Player/aFocusChat. This migration allows players + * to keep their already configured shortcuts. + */ void ShortcutsSettings::migrateShortcuts() { if (QFile(settingsFilePath).exists()) { @@ -236,9 +241,7 @@ bool ShortcutsSettings::isValid(const QString &name, const QString &sequences) c return findOverlaps(name, sequences).isEmpty(); } -/** - * Checks if the shortcut is a shortcut that is active in all windows - */ +/** @brief Checks if the shortcut is a shortcut that is active in all windows. */ static bool isAlwaysActiveShortcut(const QString &shortcutName) { return shortcutName.startsWith("MainWindow") || shortcutName.startsWith("Tabs"); diff --git a/cockatrice/src/client/settings/shortcuts_settings.h b/cockatrice/src/client/settings/shortcuts_settings.h index fc159db48..45e2c4fca 100644 --- a/cockatrice/src/client/settings/shortcuts_settings.h +++ b/cockatrice/src/client/settings/shortcuts_settings.h @@ -1,8 +1,8 @@ /** * @file shortcuts_settings.h * @ingroup CoreSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SHORTCUTSSETTINGS_H #define SHORTCUTSSETTINGS_H diff --git a/cockatrice/src/client/sound_engine.h b/cockatrice/src/client/sound_engine.h index f45cccf7d..0c201523a 100644 --- a/cockatrice/src/client/sound_engine.h +++ b/cockatrice/src/client/sound_engine.h @@ -1,8 +1,8 @@ /** * @file sound_engine.h * @ingroup Core - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SOUNDENGINE_H #define SOUNDENGINE_H diff --git a/cockatrice/src/filters/deck_filter_string.h b/cockatrice/src/filters/deck_filter_string.h index 1b43d770d..916b629ee 100644 --- a/cockatrice/src/filters/deck_filter_string.h +++ b/cockatrice/src/filters/deck_filter_string.h @@ -1,8 +1,8 @@ /** * @file deck_filter_string.h * @ingroup DeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_FILTER_STRING_H #define DECK_FILTER_STRING_H diff --git a/cockatrice/src/filters/filter_builder.h b/cockatrice/src/filters/filter_builder.h index 74872e3cd..98fe3fd02 100644 --- a/cockatrice/src/filters/filter_builder.h +++ b/cockatrice/src/filters/filter_builder.h @@ -1,8 +1,8 @@ /** * @file filter_builder.h * @ingroup CardDatabaseModelFilters - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef FILTERBUILDER_H #define FILTERBUILDER_H diff --git a/cockatrice/src/filters/filter_tree_model.h b/cockatrice/src/filters/filter_tree_model.h index c6666a838..7452f7a61 100644 --- a/cockatrice/src/filters/filter_tree_model.h +++ b/cockatrice/src/filters/filter_tree_model.h @@ -1,8 +1,8 @@ /** * @file filter_tree_model.h * @ingroup CardDatabaseModelFilters - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef FILTERTREEMODEL_H #define FILTERTREEMODEL_H diff --git a/cockatrice/src/filters/syntax_help.h b/cockatrice/src/filters/syntax_help.h index 7e5ef3e0e..d06fe03e5 100644 --- a/cockatrice/src/filters/syntax_help.h +++ b/cockatrice/src/filters/syntax_help.h @@ -2,8 +2,8 @@ * @file syntax_help.h * @ingroup CardDatabaseModelFilters * @ingroup DeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SEARCH_SYNTAX_HELP_H #define SEARCH_SYNTAX_HELP_H diff --git a/cockatrice/src/game/abstract_game.h b/cockatrice/src/game/abstract_game.h index cb4dbac2a..2441bac2d 100644 --- a/cockatrice/src/game/abstract_game.h +++ b/cockatrice/src/game/abstract_game.h @@ -1,8 +1,8 @@ /** * @file abstract_game.h * @ingroup GameLogic - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_ABSTRACT_GAME_H #define COCKATRICE_ABSTRACT_GAME_H diff --git a/cockatrice/src/game/board/abstract_card_drag_item.h b/cockatrice/src/game/board/abstract_card_drag_item.h index fe3b87983..1cbeb4fe7 100644 --- a/cockatrice/src/game/board/abstract_card_drag_item.h +++ b/cockatrice/src/game/board/abstract_card_drag_item.h @@ -1,8 +1,8 @@ /** * @file abstract_card_drag_item.h * @ingroup GameGraphicsCards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ABSTRACTCARDDRAGITEM_H #define ABSTRACTCARDDRAGITEM_H diff --git a/cockatrice/src/game/board/abstract_counter.h b/cockatrice/src/game/board/abstract_counter.h index 57bc43856..b31bd1aa3 100644 --- a/cockatrice/src/game/board/abstract_counter.h +++ b/cockatrice/src/game/board/abstract_counter.h @@ -1,8 +1,8 @@ /** * @file abstract_counter.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COUNTER_H #define COUNTER_H diff --git a/cockatrice/src/game/board/arrow_item.h b/cockatrice/src/game/board/arrow_item.h index 43c0d2b91..ebaea032a 100644 --- a/cockatrice/src/game/board/arrow_item.h +++ b/cockatrice/src/game/board/arrow_item.h @@ -1,8 +1,8 @@ /** * @file arrow_item.h * @ingroup GameGraphics - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ARROWITEM_H #define ARROWITEM_H diff --git a/cockatrice/src/game/board/arrow_target.h b/cockatrice/src/game/board/arrow_target.h index 9c9aaa315..664572705 100644 --- a/cockatrice/src/game/board/arrow_target.h +++ b/cockatrice/src/game/board/arrow_target.h @@ -1,8 +1,8 @@ /** * @file arrow_target.h * @ingroup GameGraphics - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ARROWTARGET_H #define ARROWTARGET_H diff --git a/cockatrice/src/game/board/card_drag_item.h b/cockatrice/src/game/board/card_drag_item.h index 930c6be6f..74d25ad04 100644 --- a/cockatrice/src/game/board/card_drag_item.h +++ b/cockatrice/src/game/board/card_drag_item.h @@ -1,8 +1,8 @@ /** * @file card_drag_item.h * @ingroup GameGraphicsCards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDDRAGITEM_H #define CARDDRAGITEM_H diff --git a/cockatrice/src/game/board/card_item.h b/cockatrice/src/game/board/card_item.h index 1e99dbe2a..408bb03a7 100644 --- a/cockatrice/src/game/board/card_item.h +++ b/cockatrice/src/game/board/card_item.h @@ -1,8 +1,8 @@ /** * @file card_item.h * @ingroup GameGraphicsCards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDITEM_H #define CARDITEM_H diff --git a/cockatrice/src/game/board/card_list.h b/cockatrice/src/game/board/card_list.h index 07be33b32..85a6848b7 100644 --- a/cockatrice/src/game/board/card_list.h +++ b/cockatrice/src/game/board/card_list.h @@ -1,8 +1,8 @@ /** * @file card_list.h * @ingroup GameLogicCards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDLIST_H #define CARDLIST_H diff --git a/cockatrice/src/game/board/counter_general.h b/cockatrice/src/game/board/counter_general.h index db1ee2743..0a2e882ce 100644 --- a/cockatrice/src/game/board/counter_general.h +++ b/cockatrice/src/game/board/counter_general.h @@ -1,8 +1,8 @@ /** * @file counter_general.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COUNTER_GENERAL_H #define COUNTER_GENERAL_H diff --git a/cockatrice/src/game/board/translate_counter_name.h b/cockatrice/src/game/board/translate_counter_name.h index fdb277c11..ba3a94fa5 100644 --- a/cockatrice/src/game/board/translate_counter_name.h +++ b/cockatrice/src/game/board/translate_counter_name.h @@ -1,8 +1,8 @@ /** * @file translate_counter_name.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TRANSLATECOUNTERNAME_H #define TRANSLATECOUNTERNAME_H diff --git a/cockatrice/src/game/card_dimensions.h b/cockatrice/src/game/card_dimensions.h index 255d0bc04..c59a01b48 100644 --- a/cockatrice/src/game/card_dimensions.h +++ b/cockatrice/src/game/card_dimensions.h @@ -12,16 +12,16 @@ */ namespace CardDimensions { -/// Card width in pixels +/** @brief Card width in pixels. */ constexpr int WIDTH = 72; -/// Card height in pixels +/** @brief Card height in pixels. */ constexpr int HEIGHT = 102; -/// Pre-converted for floating-point contexts (Z-value calculations) +/** @brief Pre-converted for floating-point contexts (Z-value calculations). */ constexpr qreal WIDTH_F = static_cast(WIDTH); constexpr qreal HEIGHT_F = static_cast(HEIGHT); -/// Half-dimensions for centering and rotation transforms +/** @brief Half-dimensions for centering and rotation transforms. */ constexpr qreal WIDTH_HALF_F = WIDTH_F / 2; constexpr qreal HEIGHT_HALF_F = HEIGHT_F / 2; } // namespace CardDimensions diff --git a/cockatrice/src/game/deckview/deck_view.h b/cockatrice/src/game/deckview/deck_view.h index 5abc558bd..f996fd4da 100644 --- a/cockatrice/src/game/deckview/deck_view.h +++ b/cockatrice/src/game/deckview/deck_view.h @@ -1,8 +1,8 @@ /** * @file deck_view.h * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECKVIEW_H #define DECKVIEW_H diff --git a/cockatrice/src/game/deckview/deck_view_container.h b/cockatrice/src/game/deckview/deck_view_container.h index 6d685cd79..ec024bace 100644 --- a/cockatrice/src/game/deckview/deck_view_container.h +++ b/cockatrice/src/game/deckview/deck_view_container.h @@ -1,8 +1,8 @@ /** * @file deck_view_container.h * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_VIEW_CONTAINER_H #define DECK_VIEW_CONTAINER_H diff --git a/cockatrice/src/game/deckview/tabbed_deck_view_container.h b/cockatrice/src/game/deckview/tabbed_deck_view_container.h index c34eef1ef..7cfa8c9aa 100644 --- a/cockatrice/src/game/deckview/tabbed_deck_view_container.h +++ b/cockatrice/src/game/deckview/tabbed_deck_view_container.h @@ -1,8 +1,8 @@ /** * @file tabbed_deck_view_container.h * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TABBED_DECK_VIEW_CONTAINER_H #define TABBED_DECK_VIEW_CONTAINER_H diff --git a/cockatrice/src/game/dialogs/dlg_create_token.h b/cockatrice/src/game/dialogs/dlg_create_token.h index 9a18f1a57..281e161fc 100644 --- a/cockatrice/src/game/dialogs/dlg_create_token.h +++ b/cockatrice/src/game/dialogs/dlg_create_token.h @@ -1,8 +1,8 @@ /** * @file dlg_create_token.h * @ingroup GameDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_CREATETOKEN_H #define DLG_CREATETOKEN_H diff --git a/cockatrice/src/game/dialogs/dlg_move_top_cards_until.h b/cockatrice/src/game/dialogs/dlg_move_top_cards_until.h index 20ba11c5c..ac9d41a94 100644 --- a/cockatrice/src/game/dialogs/dlg_move_top_cards_until.h +++ b/cockatrice/src/game/dialogs/dlg_move_top_cards_until.h @@ -1,8 +1,8 @@ /** * @file dlg_move_top_cards_until.h * @ingroup GameDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_MOVE_TOP_CARDS_UNTIL_H #define DLG_MOVE_TOP_CARDS_UNTIL_H diff --git a/cockatrice/src/game/dialogs/dlg_roll_dice.h b/cockatrice/src/game/dialogs/dlg_roll_dice.h index 69edd0757..15f7dc1ba 100644 --- a/cockatrice/src/game/dialogs/dlg_roll_dice.h +++ b/cockatrice/src/game/dialogs/dlg_roll_dice.h @@ -1,8 +1,8 @@ /** * @file dlg_roll_dice.h * @ingroup GameDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_ROLL_DICE_H #define DLG_ROLL_DICE_H diff --git a/cockatrice/src/game/game.h b/cockatrice/src/game/game.h index 96ebbae4d..ccdb679df 100644 --- a/cockatrice/src/game/game.h +++ b/cockatrice/src/game/game.h @@ -1,8 +1,8 @@ /** * @file game.h * @ingroup GameLogic - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_GAME_H #define COCKATRICE_GAME_H diff --git a/cockatrice/src/game/game_event_handler.h b/cockatrice/src/game/game_event_handler.h index 250f2c185..7587ab46d 100644 --- a/cockatrice/src/game/game_event_handler.h +++ b/cockatrice/src/game/game_event_handler.h @@ -1,8 +1,8 @@ /** * @file game_event_handler.h * @ingroup GameLogic - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_GAME_EVENT_HANDLER_H #define COCKATRICE_GAME_EVENT_HANDLER_H diff --git a/cockatrice/src/game/game_meta_info.h b/cockatrice/src/game/game_meta_info.h index 8226af2ae..cdba1605f 100644 --- a/cockatrice/src/game/game_meta_info.h +++ b/cockatrice/src/game/game_meta_info.h @@ -1,8 +1,8 @@ /** * @file game_meta_info.h * @ingroup GameLogic - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef GAME_META_INFO_H #define GAME_META_INFO_H diff --git a/cockatrice/src/game/game_scene.h b/cockatrice/src/game/game_scene.h index aadbd536e..5e0e6b7c9 100644 --- a/cockatrice/src/game/game_scene.h +++ b/cockatrice/src/game/game_scene.h @@ -59,10 +59,12 @@ private: */ void updateHover(const QPointF &scenePos); - /// Activates hover state and escapes the card from its clip container so hover scaling is visible beyond zone - /// bounds. + /** + * @brief Activates hover state and escapes the card from its clip container + * so hover scaling is visible beyond zone bounds. + */ void beginCardHover(CardItem *card); - /// Deactivates hover state and restores the card to its clip container. + /** @brief Deactivates hover state and restores the card to its clip container. */ void endCardHover(CardItem *card); public: @@ -73,13 +75,13 @@ public: */ explicit GameScene(PhasesToolbar *_phasesToolbar, QObject *parent = nullptr); - /** Destructor, cleans up timer and zone views. */ + /** @brief Destructor, cleans up timer and zone views. */ ~GameScene() override; - /** Updates UI text for all zone views. */ + /** @brief Updates UI text for all zone views. */ void retranslateUi(); - /** Gets all selected CardItems */ + /** @brief Gets all selected CardItems. */ QList selectedCards() const; /** @@ -100,7 +102,7 @@ public: */ void adjustPlayerRotation(int rotationAdjustment); - /** Recomputes the layout of players and the scene size. */ + /** @brief Recomputes the layout of players and the scene size. */ void rearrange(); /** @@ -160,41 +162,41 @@ public: */ void resizeColumnsAndPlayers(const QList &minWidthByColumn, qreal newWidth); - /** Finds the topmost card zone under the cursor. */ + /** @brief Finds the topmost card zone under the cursor. */ static CardZone *findTopmostZone(const QList &items); - /** Finds the topmost card in a given zone, considering attachments and Z-order. */ + /** @brief Finds the topmost card in a given zone, considering attachments and Z-order. */ static CardItem *findTopmostCardInZone(const QList &items, CardZone *zone); - /** Updates hovered card highlighting. */ + /** @brief Updates hovered card highlighting. */ void updateHoveredCard(CardItem *newCard); - /** Registers a card for animation updates. */ + /** @brief Registers a card for animation updates. */ void registerAnimationItem(AbstractCardItem *card); - /** Unregisters a card from animation updates. */ + /** @brief Unregisters a card from animation updates. */ void unregisterAnimationItem(AbstractCardItem *card); void startRubberBand(const QPointF &selectionOrigin); void resizeRubberBand(const QPointF &cursorPoint, int selectedCount); void stopRubberBand(); public slots: - /** Toggles a zone view for a player. */ + /** @brief Toggles a zone view for a player. */ void toggleZoneView(PlayerLogic *player, const QString &zoneName, int numberCards, bool isReversed = false); - /** Adds a revealed zone view (for shown cards). */ + /** @brief Adds a revealed zone view (for shown cards). */ void addRevealedZoneView(PlayerLogic *player, CardZoneLogic *zone, const QList &cardList, bool withWritePermission); - /** Removes a zone view widget from the scene. */ + /** @brief Removes a zone view widget from the scene. */ void removeZoneView(ZoneViewWidget *item); - /** Closes all zone views. */ + /** @brief Closes all zone views. */ void clearViews(); - /** Closes the most recently added zone view. */ + /** @brief Closes the most recently added zone view. */ void closeMostRecentZoneView(); QTransform getViewTransform() const; QTransform getViewportTransform() const; @@ -205,10 +207,10 @@ public slots: void clearArrowsForPlayer(int playerId); protected: - /** Handles hover updates. */ + /** @brief Handles hover updates. */ bool event(QEvent *event) override; - /** Handles animation timer updates. */ + /** @brief Handles animation timer updates. */ void timerEvent(QTimerEvent *event) override; signals: diff --git a/cockatrice/src/game/game_state.h b/cockatrice/src/game/game_state.h index 54f6d9276..5a57d4321 100644 --- a/cockatrice/src/game/game_state.h +++ b/cockatrice/src/game/game_state.h @@ -1,8 +1,8 @@ /** * @file game_state.h * @ingroup GameLogic - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_GAME_STATE_H #define COCKATRICE_GAME_STATE_H diff --git a/cockatrice/src/game/game_view.h b/cockatrice/src/game/game_view.h index a77ab9257..15abad9af 100644 --- a/cockatrice/src/game/game_view.h +++ b/cockatrice/src/game/game_view.h @@ -1,8 +1,8 @@ /** * @file game_view.h * @ingroup GameGraphics - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef GAMEVIEW_H #define GAMEVIEW_H diff --git a/cockatrice/src/game/hand_counter.h b/cockatrice/src/game/hand_counter.h index 2c0175ecc..41ab3b5b2 100644 --- a/cockatrice/src/game/hand_counter.h +++ b/cockatrice/src/game/hand_counter.h @@ -1,8 +1,8 @@ /** * @file hand_counter.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef HANDCOUNTER_H #define HANDCOUNTER_H diff --git a/cockatrice/src/game/log/message_log_widget.h b/cockatrice/src/game/log/message_log_widget.h index f8d70a52e..9f1990ac4 100644 --- a/cockatrice/src/game/log/message_log_widget.h +++ b/cockatrice/src/game/log/message_log_widget.h @@ -1,8 +1,8 @@ /** * @file message_log_widget.h * @ingroup GameWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MESSAGELOGWIDGET_H #define MESSAGELOGWIDGET_H diff --git a/cockatrice/src/game/phase.h b/cockatrice/src/game/phase.h index 2e712932f..a888ad43b 100644 --- a/cockatrice/src/game/phase.h +++ b/cockatrice/src/game/phase.h @@ -1,8 +1,8 @@ /** * @file phase.h * @ingroup GameLogic - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PHASE_H #define PHASE_H diff --git a/cockatrice/src/game/phases_toolbar.h b/cockatrice/src/game/phases_toolbar.h index dd2477424..6f0931d61 100644 --- a/cockatrice/src/game/phases_toolbar.h +++ b/cockatrice/src/game/phases_toolbar.h @@ -2,8 +2,8 @@ * @file phases_toolbar.h * @ingroup GameGraphics * @ingroup GameWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PHASESTOOLBAR_H #define PHASESTOOLBAR_H diff --git a/cockatrice/src/game/player/card_menu_action_type.h b/cockatrice/src/game/player/card_menu_action_type.h index 1b63674fa..4cae22716 100644 --- a/cockatrice/src/game/player/card_menu_action_type.h +++ b/cockatrice/src/game/player/card_menu_action_type.h @@ -1,8 +1,8 @@ /** * @file card_menu_action_type.h * @ingroup GameMenusPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_CARD_MENU_ACTION_TYPE_H #define COCKATRICE_CARD_MENU_ACTION_TYPE_H diff --git a/cockatrice/src/game/player/event_processing_options.h b/cockatrice/src/game/player/event_processing_options.h index 3e743bdb3..4c7663789 100644 --- a/cockatrice/src/game/player/event_processing_options.h +++ b/cockatrice/src/game/player/event_processing_options.h @@ -1,8 +1,8 @@ /** * @file event_processing_options.h * @ingroup GameLogicPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_EVENT_PROCESSING_OPTIONS_H #define COCKATRICE_EVENT_PROCESSING_OPTIONS_H diff --git a/cockatrice/src/game/player/menu/abstract_player_component.h b/cockatrice/src/game/player/menu/abstract_player_component.h index 989300d41..ee310c428 100644 --- a/cockatrice/src/game/player/menu/abstract_player_component.h +++ b/cockatrice/src/game/player/menu/abstract_player_component.h @@ -19,13 +19,13 @@ class AbstractPlayerComponent public: virtual ~AbstractPlayerComponent() = default; - /// Bind keyboard shortcuts. Called when this player gains focus. + /** @brief Bind keyboard shortcuts. Called when this player gains focus. */ virtual void setShortcutsActive() = 0; - /// Unbind keyboard shortcuts. Called when this player loses focus. + /** @brief Unbind keyboard shortcuts. Called when this player loses focus. */ virtual void setShortcutsInactive() = 0; - /// Retranslate all user-visible strings. Called on language change. + /** @brief Retranslate all user-visible strings. Called on language change. */ virtual void retranslateUi() = 0; }; diff --git a/cockatrice/src/game/player/menu/card_menu.h b/cockatrice/src/game/player/menu/card_menu.h index d214d3557..ad3962caf 100644 --- a/cockatrice/src/game/player/menu/card_menu.h +++ b/cockatrice/src/game/player/menu/card_menu.h @@ -1,8 +1,8 @@ /** * @file card_menu.h * @ingroup GameMenusCards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_CARD_MENU_H #define COCKATRICE_CARD_MENU_H diff --git a/cockatrice/src/game/player/menu/custom_zone_menu.h b/cockatrice/src/game/player/menu/custom_zone_menu.h index a6ea15892..e10f6a4f0 100644 --- a/cockatrice/src/game/player/menu/custom_zone_menu.h +++ b/cockatrice/src/game/player/menu/custom_zone_menu.h @@ -1,8 +1,8 @@ /** * @file custom_zone_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_CUSTOM_ZONE_MENU_H #define COCKATRICE_CUSTOM_ZONE_MENU_H diff --git a/cockatrice/src/game/player/menu/grave_menu.h b/cockatrice/src/game/player/menu/grave_menu.h index 167714013..d3d98802d 100644 --- a/cockatrice/src/game/player/menu/grave_menu.h +++ b/cockatrice/src/game/player/menu/grave_menu.h @@ -1,8 +1,8 @@ /** * @file grave_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_GRAVE_MENU_H #define COCKATRICE_GRAVE_MENU_H diff --git a/cockatrice/src/game/player/menu/hand_menu.h b/cockatrice/src/game/player/menu/hand_menu.h index 4fdd0d6fc..1e2ddd95a 100644 --- a/cockatrice/src/game/player/menu/hand_menu.h +++ b/cockatrice/src/game/player/menu/hand_menu.h @@ -1,8 +1,8 @@ /** * @file hand_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_HAND_MENU_H #define COCKATRICE_HAND_MENU_H diff --git a/cockatrice/src/game/player/menu/library_menu.h b/cockatrice/src/game/player/menu/library_menu.h index e69a395e2..a941c54b1 100644 --- a/cockatrice/src/game/player/menu/library_menu.h +++ b/cockatrice/src/game/player/menu/library_menu.h @@ -1,8 +1,8 @@ /** * @file library_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_LIBRARY_MENU_H #define COCKATRICE_LIBRARY_MENU_H diff --git a/cockatrice/src/game/player/menu/move_menu.h b/cockatrice/src/game/player/menu/move_menu.h index 59078a5c8..4e257b7fb 100644 --- a/cockatrice/src/game/player/menu/move_menu.h +++ b/cockatrice/src/game/player/menu/move_menu.h @@ -1,8 +1,8 @@ /** * @file move_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_MOVE_MENU_H #define COCKATRICE_MOVE_MENU_H diff --git a/cockatrice/src/game/player/menu/player_menu.h b/cockatrice/src/game/player/menu/player_menu.h index 78e810e62..d5c19df58 100644 --- a/cockatrice/src/game/player/menu/player_menu.h +++ b/cockatrice/src/game/player/menu/player_menu.h @@ -41,7 +41,7 @@ private slots: public: explicit PlayerMenu(PlayerLogic *player); - /// Lifecycle methods: delegate to all managedComponents, plus counters separately via player->getCounters(). + /** @brief Retranslate all user-visible strings. Called on language change. */ void retranslateUi(); QMenu *updateCardMenu(const CardItem *card); @@ -71,9 +71,9 @@ public: return shortcutsActive; } - /// Delegates to all managedComponents, plus counters separately. + /** @brief Bind keyboard shortcuts. Called when this player gains focus. */ void setShortcutsActive(); - /// Delegates to all managedComponents, plus counters separately. + /** @brief Unbind keyboard shortcuts. Called when this player loses focus. */ void setShortcutsInactive(); private: @@ -89,11 +89,13 @@ private: SayMenu *sayMenu; CustomZoneMenu *customZonesMenu; - /// Drives AbstractPlayerComponent lifecycle delegation. Counters are iterated separately via player->getCounters(). + /** @brief Drives AbstractPlayerComponent lifecycle delegation. Counters are iterated separately via + * player->getCounters(). + */ QList managedComponents; bool shortcutsActive = false; - /// Creates component, adds it as a submenu of playerMenu, and registers in managedComponents. + /** @brief Creates component, adds it as a submenu of playerMenu, and registers in managedComponents. */ template MenuT *addManagedMenu(Args &&...args) { auto *menu = new MenuT(std::forward(args)...); @@ -102,7 +104,7 @@ private: return menu; } - /// Creates component and registers in managedComponents, but does NOT add it as a submenu. + /** @brief Creates component and registers in managedComponents, but does NOT add it as a submenu. */ template ComponentT *createManagedComponent(Args &&...args) { auto *component = new ComponentT(std::forward(args)...); diff --git a/cockatrice/src/game/player/menu/pt_menu.h b/cockatrice/src/game/player/menu/pt_menu.h index a1cbd021c..645449586 100644 --- a/cockatrice/src/game/player/menu/pt_menu.h +++ b/cockatrice/src/game/player/menu/pt_menu.h @@ -1,8 +1,8 @@ /** * @file pt_menu.h * @ingroup GameMenusCards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PT_MENU_H #define COCKATRICE_PT_MENU_H diff --git a/cockatrice/src/game/player/menu/rfg_menu.h b/cockatrice/src/game/player/menu/rfg_menu.h index 7025169c8..9e179f8fd 100644 --- a/cockatrice/src/game/player/menu/rfg_menu.h +++ b/cockatrice/src/game/player/menu/rfg_menu.h @@ -1,8 +1,8 @@ /** * @file rfg_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_RFG_MENU_H #define COCKATRICE_RFG_MENU_H diff --git a/cockatrice/src/game/player/menu/say_menu.h b/cockatrice/src/game/player/menu/say_menu.h index 938990193..3de70e85c 100644 --- a/cockatrice/src/game/player/menu/say_menu.h +++ b/cockatrice/src/game/player/menu/say_menu.h @@ -1,8 +1,8 @@ /** * @file say_menu.h * @ingroup GameMenusPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_SAY_MENU_H #define COCKATRICE_SAY_MENU_H diff --git a/cockatrice/src/game/player/menu/sideboard_menu.h b/cockatrice/src/game/player/menu/sideboard_menu.h index b5385997f..20a206782 100644 --- a/cockatrice/src/game/player/menu/sideboard_menu.h +++ b/cockatrice/src/game/player/menu/sideboard_menu.h @@ -1,8 +1,8 @@ /** * @file sideboard_menu.h * @ingroup GameMenusZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_SIDEBOARD_MENU_H #define COCKATRICE_SIDEBOARD_MENU_H diff --git a/cockatrice/src/game/player/menu/utility_menu.h b/cockatrice/src/game/player/menu/utility_menu.h index 6d922d726..fab3211ca 100644 --- a/cockatrice/src/game/player/menu/utility_menu.h +++ b/cockatrice/src/game/player/menu/utility_menu.h @@ -1,8 +1,8 @@ /** * @file utility_menu.h * @ingroup GameMenusPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_UTILITY_MENU_H #define COCKATRICE_UTILITY_MENU_H diff --git a/cockatrice/src/game/player/player_actions.h b/cockatrice/src/game/player/player_actions.h index 535e37707..d294d2c40 100644 --- a/cockatrice/src/game/player/player_actions.h +++ b/cockatrice/src/game/player/player_actions.h @@ -2,8 +2,8 @@ * @file player_actions.h * @ingroup GameLogicActions * @ingroup GameLogicPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PLAYER_ACTIONS_H #define COCKATRICE_PLAYER_ACTIONS_H diff --git a/cockatrice/src/game/player/player_area.h b/cockatrice/src/game/player/player_area.h index ec0d23cb6..6ffaf4958 100644 --- a/cockatrice/src/game/player/player_area.h +++ b/cockatrice/src/game/player/player_area.h @@ -1,8 +1,8 @@ /** * @file player_area.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PLAYER_AREA_H #define COCKATRICE_PLAYER_AREA_H diff --git a/cockatrice/src/game/player/player_event_handler.h b/cockatrice/src/game/player/player_event_handler.h index 84acbb8ea..958dee16b 100644 --- a/cockatrice/src/game/player/player_event_handler.h +++ b/cockatrice/src/game/player/player_event_handler.h @@ -1,8 +1,8 @@ /** * @file player_event_handler.h * @ingroup GameLogicPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PLAYER_EVENT_HANDLER_H #define COCKATRICE_PLAYER_EVENT_HANDLER_H diff --git a/cockatrice/src/game/player/player_graphics_item.h b/cockatrice/src/game/player/player_graphics_item.h index 264654e9c..e37fe7290 100644 --- a/cockatrice/src/game/player/player_graphics_item.h +++ b/cockatrice/src/game/player/player_graphics_item.h @@ -1,8 +1,8 @@ /** * @file player_graphics_item.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PLAYER_GRAPHICS_ITEM_H #define COCKATRICE_PLAYER_GRAPHICS_ITEM_H diff --git a/cockatrice/src/game/player/player_info.h b/cockatrice/src/game/player/player_info.h index 36cb2a8bc..e67131ceb 100644 --- a/cockatrice/src/game/player/player_info.h +++ b/cockatrice/src/game/player/player_info.h @@ -1,8 +1,8 @@ /** * @file player_info.h * @ingroup GameLogicPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PLAYER_INFO_H #define COCKATRICE_PLAYER_INFO_H diff --git a/cockatrice/src/game/player/player_list_widget.h b/cockatrice/src/game/player/player_list_widget.h index 1815fdccd..842c45873 100644 --- a/cockatrice/src/game/player/player_list_widget.h +++ b/cockatrice/src/game/player/player_list_widget.h @@ -1,8 +1,8 @@ /** * @file player_list_widget.h * @ingroup GameWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PLAYERLISTWIDGET_H #define PLAYERLISTWIDGET_H diff --git a/cockatrice/src/game/player/player_logic.h b/cockatrice/src/game/player/player_logic.h index 138ed94ef..fdeef49ba 100644 --- a/cockatrice/src/game/player/player_logic.h +++ b/cockatrice/src/game/player/player_logic.h @@ -1,8 +1,8 @@ /** * @file player.h * @ingroup GameLogicPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PLAYER_H #define PLAYER_H diff --git a/cockatrice/src/game/player/player_manager.h b/cockatrice/src/game/player/player_manager.h index 4f6d62a87..2f8b87af8 100644 --- a/cockatrice/src/game/player/player_manager.h +++ b/cockatrice/src/game/player/player_manager.h @@ -1,8 +1,8 @@ /** * @file player_manager.h * @ingroup GameLogicPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PLAYER_MANAGER_H #define COCKATRICE_PLAYER_MANAGER_H diff --git a/cockatrice/src/game/player/player_target.h b/cockatrice/src/game/player/player_target.h index 0dd494ce3..d3facc60d 100644 --- a/cockatrice/src/game/player/player_target.h +++ b/cockatrice/src/game/player/player_target.h @@ -1,8 +1,8 @@ /** * @file player_target.h * @ingroup GameGraphicsPlayers - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PLAYERTARGET_H #define PLAYERTARGET_H diff --git a/cockatrice/src/game/replay.h b/cockatrice/src/game/replay.h index 301f47580..b837e4b8c 100644 --- a/cockatrice/src/game/replay.h +++ b/cockatrice/src/game/replay.h @@ -2,8 +2,8 @@ * @file replay.h * @ingroup GameLogic * @ingroup Replay - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_REPLAY_H #define COCKATRICE_REPLAY_H diff --git a/cockatrice/src/game/z_value_layer_manager.h b/cockatrice/src/game/z_value_layer_manager.h index 4eb864486..d35ab5c1c 100644 --- a/cockatrice/src/game/z_value_layer_manager.h +++ b/cockatrice/src/game/z_value_layer_manager.h @@ -66,12 +66,9 @@ namespace ZValueLayerManager */ enum class Layer { - /// Zone-level elements like backgrounds and containers - Zone, - /// Cards rendered in zones (uses sequential Z-values) - Card, - /// Temporary UI elements like hovered cards and drag items - Overlay + Zone, ///< Zone-level elements like backgrounds and containers. + Card, ///< Cards rendered in zones (uses sequential Z-values). + Overlay ///< Temporary UI elements like hovered cards and drag items. }; /** diff --git a/cockatrice/src/game/zones/card_zone_logic.h b/cockatrice/src/game/zones/card_zone_logic.h index 63341343b..ae97719a9 100644 --- a/cockatrice/src/game/zones/card_zone_logic.h +++ b/cockatrice/src/game/zones/card_zone_logic.h @@ -1,8 +1,8 @@ /** * @file card_zone_logic.h * @ingroup GameLogicZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_CARD_ZONE_LOGIC_H #define COCKATRICE_CARD_ZONE_LOGIC_H diff --git a/cockatrice/src/game/zones/hand_zone_logic.h b/cockatrice/src/game/zones/hand_zone_logic.h index e5032b327..400506248 100644 --- a/cockatrice/src/game/zones/hand_zone_logic.h +++ b/cockatrice/src/game/zones/hand_zone_logic.h @@ -1,8 +1,8 @@ /** * @file hand_zone_logic.h * @ingroup GameLogicZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_HAND_ZONE_LOGIC_H #define COCKATRICE_HAND_ZONE_LOGIC_H diff --git a/cockatrice/src/game/zones/pile_zone_logic.h b/cockatrice/src/game/zones/pile_zone_logic.h index 68b39ec3a..522d99b89 100644 --- a/cockatrice/src/game/zones/pile_zone_logic.h +++ b/cockatrice/src/game/zones/pile_zone_logic.h @@ -1,8 +1,8 @@ /** * @file pile_zone_logic.h * @ingroup GameLogicZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_PILE_ZONE_LOGIC_H #define COCKATRICE_PILE_ZONE_LOGIC_H diff --git a/cockatrice/src/game/zones/stack_zone_logic.h b/cockatrice/src/game/zones/stack_zone_logic.h index a0ac65ebf..cce4bd0fa 100644 --- a/cockatrice/src/game/zones/stack_zone_logic.h +++ b/cockatrice/src/game/zones/stack_zone_logic.h @@ -1,8 +1,8 @@ /** * @file stack_zone_logic.h * @ingroup GameLogicZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_STACK_ZONE_LOGIC_H #define COCKATRICE_STACK_ZONE_LOGIC_H diff --git a/cockatrice/src/game/zones/table_zone_logic.h b/cockatrice/src/game/zones/table_zone_logic.h index 1e473d4ef..6d8d64a20 100644 --- a/cockatrice/src/game/zones/table_zone_logic.h +++ b/cockatrice/src/game/zones/table_zone_logic.h @@ -1,8 +1,8 @@ /** * @file table_zone_logic.h * @ingroup GameLogicZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_TABLE_ZONE_LOGIC_H #define COCKATRICE_TABLE_ZONE_LOGIC_H diff --git a/cockatrice/src/game/zones/view_zone_logic.h b/cockatrice/src/game/zones/view_zone_logic.h index ef0fb37f3..04ed20e45 100644 --- a/cockatrice/src/game/zones/view_zone_logic.h +++ b/cockatrice/src/game/zones/view_zone_logic.h @@ -1,8 +1,8 @@ /** * @file view_zone_logic.h * @ingroup GameLogicZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_VIEW_ZONE_LOGIC_H #define COCKATRICE_VIEW_ZONE_LOGIC_H diff --git a/cockatrice/src/game_graphics/board/abstract_graphics_item.h b/cockatrice/src/game_graphics/board/abstract_graphics_item.h index 93b9bff1b..287c2c0b3 100644 --- a/cockatrice/src/game_graphics/board/abstract_graphics_item.h +++ b/cockatrice/src/game_graphics/board/abstract_graphics_item.h @@ -1,8 +1,8 @@ /** * @file abstract_graphics_item.h * @ingroup GameGraphics - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ABSTRACTGRAPHICSITEM_H #define ABSTRACTGRAPHICSITEM_H diff --git a/cockatrice/src/game_graphics/board/graphics_item_type.h b/cockatrice/src/game_graphics/board/graphics_item_type.h index c48ae4ed6..7eac132b0 100644 --- a/cockatrice/src/game_graphics/board/graphics_item_type.h +++ b/cockatrice/src/game_graphics/board/graphics_item_type.h @@ -1,8 +1,8 @@ /** * @file graphics_item_type.h * @ingroup GameGraphics - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_GRAPHICS_ITEM_TYPE_H #define COCKATRICE_GRAPHICS_ITEM_TYPE_H diff --git a/cockatrice/src/game_graphics/zones/card_zone.h b/cockatrice/src/game_graphics/zones/card_zone.h index 80226de3c..4cef6ca80 100644 --- a/cockatrice/src/game_graphics/zones/card_zone.h +++ b/cockatrice/src/game_graphics/zones/card_zone.h @@ -40,9 +40,12 @@ protected: } public slots: bool showContextMenu(const QPoint &screenPos); - /// @brief Called when a card is added to this zone. Default: reparents card to this item. - /// Virtual so subclasses (e.g. SelectZone) can override parenting behavior — the Qt signal - /// connection in CardZone's constructor dispatches through the vtable. + /** + * @brief Called when a card is added to this zone. Default: reparents card to this item. + * + * Virtual so subclasses (e.g. SelectZone) can override parenting behavior — the Qt signal + * connection in CardZone's constructor dispatches through the vtable. + */ virtual void onCardAdded(CardItem *addedCard); public: diff --git a/cockatrice/src/game_graphics/zones/pile_zone.h b/cockatrice/src/game_graphics/zones/pile_zone.h index 8cf04676d..099bc6f60 100644 --- a/cockatrice/src/game_graphics/zones/pile_zone.h +++ b/cockatrice/src/game_graphics/zones/pile_zone.h @@ -1,8 +1,8 @@ /** * @file pile_zone.h * @ingroup GameGraphicsZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PILEZONE_H #define PILEZONE_H diff --git a/cockatrice/src/game_graphics/zones/select_zone.h b/cockatrice/src/game_graphics/zones/select_zone.h index 1da5c1988..7408f29b6 100644 --- a/cockatrice/src/game_graphics/zones/select_zone.h +++ b/cockatrice/src/game_graphics/zones/select_zone.h @@ -21,33 +21,41 @@ class SelectZone : public CardZone { Q_OBJECT public: - /// Finds the SelectZone that owns a card, regardless of whether the card is parented - /// to the zone directly or to its clip container. Returns nullptr if not in a SelectZone. + /** + * @brief Finds the SelectZone that owns a card, regardless of whether the card is parented + * to the zone directly or to its clip container. Returns nullptr if not in a SelectZone. + */ static SelectZone *findOwningSelectZone(const QGraphicsItem *card); SelectZone(CardZoneLogic *logic, QGraphicsItem *parent = nullptr); ~SelectZone() override; void onCardAdded(CardItem *addedCard) override; - /// @brief Temporarily reparents a card from the clip container to this zone so hover scaling is visible beyond clip - /// bounds. Safe no-op if no clip container exists. Coordinates are preserved (clip container is at (0,0) with no - /// transform). + /** + * @brief Temporarily reparents a card from the clip container to this zone so hover scaling is visible beyond clip + * bounds. Safe no-op if no clip container exists. Coordinates are preserved (clip container is at (0,0) with no + * transform). + */ void escapeClipForHover(QGraphicsItem *card); - /// @brief Restores a hover-escaped card back to the clip container. Guards against zone transitions that already - /// reparented the card. + /** + * @brief Restores a hover-escaped card back to the clip container. Guards against zone transitions that already + * reparented the card. + */ void restoreClipAfterHover(QGraphicsItem *card); private: QPointF selectionOrigin; QSet cardsInSelectionRect; - /// Invisible clipping parent for cards; owned by Qt parent-child tree (parented to this zone). - /// Created by setupClipContainer(); null when no clip container is active. + /** + * @brief Invisible clipping parent for cards; owned by Qt parent-child tree (parented to this zone). + * Created by setupClipContainer(); null when no clip container is active. + */ QGraphicsRectItem *cardClipContainer = nullptr; protected: // -- Layout computation -- - /// Parameters describing a vertical card stack's geometry. + /** @brief Parameters describing a vertical card stack's geometry. */ struct StackLayoutParams { int cardCount; ///< Number of cards in the stack @@ -55,21 +63,23 @@ protected: qreal cardHeight; ///< Height of a single card qreal desiredOffset; ///< Preferred vertical offset between card tops qreal minOffset = 0.0; ///< Minimum offset to preserve (0 allows full compression) - /// When false (default), reserves full cardHeight for the bottom card, ensuring - /// all cards remain within zone bounds. When true, allows the bottom card to - /// partially overflow using sqrt-scaled allowance. Use with setupClipContainer() - /// for zones too short to fit a full card. + /** + * @brief When false (default), reserves full cardHeight for the bottom card, ensuring + * all cards remain within zone bounds. When true, allows the bottom card to + * partially overflow using sqrt-scaled allowance. Use with setupClipContainer() + * for zones too short to fit a full card. + */ bool allowBottomOverflow = false; }; - /// Result of computing a vertical stack layout. + /** @brief Result of computing a vertical stack layout. */ struct ZoneLayout { qreal effectiveOffset; ///< Actual offset between card tops (may be compressed) qreal start; ///< Y coordinate of the first card's top edge }; - /// Minimum visible pixels of each card's top edge when stacking compresses offsets in tight zones. + /** @brief Minimum visible pixels of each card's top edge when stacking compresses offsets in tight zones. */ static constexpr qreal MIN_CARD_VISIBLE = 10.0; /** @@ -88,11 +98,13 @@ protected: */ static ZoneLayout computeZoneLayout(const StackLayoutParams ¶ms); - /// Builds StackLayoutParams from the current card list and zone geometry. + /** @brief Builds StackLayoutParams from the current card list and zone geometry. */ StackLayoutParams buildStackParams(qreal minOffset = 0.0) const; - /// Computes the card index at a given y-coordinate within the zone's vertical layout. - /// Returns 0 if the zone has no cards or the offset is zero. + /** + * @brief Computes the card index at a given y-coordinate within the zone's vertical layout. + * Returns 0 if the zone has no cards or the offset is zero. + */ int calcDropIndexFromY(qreal dropY, qreal minOffset = 0.0) const; /** @@ -111,17 +123,21 @@ protected: // (e.g., zones too short to fit a full card). To enable: call setupClipContainer() in the // zone's constructor, and set allowBottomOverflow=true in layout params. - /// Restores any cards that were hover-escaped but whose hover state was not properly cleaned up. - /// Call at the start of reorganizeCards() in zones that use a clip container. + /** + * @brief Restores any cards that were hover-escaped but whose hover state was not properly cleaned up. + * Call at the start of reorganizeCards() in zones that use a clip container. + */ void restoreStaleEscapedCards(); - /// Creates a clip container child item that clips card overflow to zone bounds. - /// Cards entering this zone are reparented to this container by the onCardAdded override. - /// Disables zone-level child clipping; clipping is delegated to the container. - /// @param zValue Optional z-value for the clip container (e.g. ZValues::CARD_BASE) + /** + * @brief Creates a clip container child item that clips card overflow to zone bounds. + * Cards entering this zone are reparented to this container by the onCardAdded override. + * Disables zone-level child clipping; clipping is delegated to the container. + * @param zValue Optional z-value for the clip container (e.g. ZValues::CARD_BASE) + */ void setupClipContainer(std::optional zValue = std::nullopt); - /// Updates the clip container rect to match this zone's current boundingRect(). + /** @brief Updates the clip container rect to match this zone's current boundingRect(). */ void updateClipRect(); void mouseMoveEvent(QGraphicsSceneMouseEvent *event) override; diff --git a/cockatrice/src/game_graphics/zones/stack_zone.h b/cockatrice/src/game_graphics/zones/stack_zone.h index ed13ae1f9..147c3e2fc 100644 --- a/cockatrice/src/game_graphics/zones/stack_zone.h +++ b/cockatrice/src/game_graphics/zones/stack_zone.h @@ -20,7 +20,7 @@ private slots: public: StackZone(StackZoneLogic *_logic, int _zoneHeight, QGraphicsItem *parent); - /// @brief Resizes the stack zone height, e.g. when sharing vertical space with the command zone. + /** @brief Resizes the stack zone height, e.g. when sharing vertical space with the command zone. */ void setHeight(qreal newHeight); void handleDropEvent(const QList &dragItems, CardZoneLogic *startZone, const QPoint &dropPoint) override; diff --git a/cockatrice/src/game_graphics/zones/table_zone.h b/cockatrice/src/game_graphics/zones/table_zone.h index b5e941782..f46531520 100644 --- a/cockatrice/src/game_graphics/zones/table_zone.h +++ b/cockatrice/src/game_graphics/zones/table_zone.h @@ -1,8 +1,8 @@ /** * @file table_zone.h * @ingroup GameGraphicsZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TABLEZONE_H #define TABLEZONE_H @@ -11,13 +11,12 @@ #include "../../game/zones/table_zone_logic.h" #include "select_zone.h" -/* - * TableZone is the grid based rect where CardItems may be placed. - * It is the main play zone and can be customized with background images. +/** + * @brief TableZone is the grid based rect where CardItems may be placed. * - * TODO: Refactor methods to make more readable, extract some logic to - * private methods (Im looking at you TableZone::reorganizeCards()) + * It is the main play zone and can be customized with background images. */ +//! \todo Refactor methods to make more readable, extract logic to private methods (especially reorganizeCards()). class TableZone : public SelectZone { Q_OBJECT diff --git a/cockatrice/src/game_graphics/zones/view_zone.h b/cockatrice/src/game_graphics/zones/view_zone.h index 65e4846d0..9dfa00ce2 100644 --- a/cockatrice/src/game_graphics/zones/view_zone.h +++ b/cockatrice/src/game_graphics/zones/view_zone.h @@ -1,8 +1,8 @@ /** * @file view_zone.h * @ingroup GameGraphicsZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ZONEVIEWERZONE_H #define ZONEVIEWERZONE_H diff --git a/cockatrice/src/game_graphics/zones/view_zone_widget.h b/cockatrice/src/game_graphics/zones/view_zone_widget.h index 6d59a5429..de5ad28d5 100644 --- a/cockatrice/src/game_graphics/zones/view_zone_widget.h +++ b/cockatrice/src/game_graphics/zones/view_zone_widget.h @@ -1,8 +1,8 @@ /** * @file view_zone_widget.h * @ingroup GameGraphicsZones - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ZONEVIEWWIDGET_H #define ZONEVIEWWIDGET_H diff --git a/cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp b/cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp index f95d8ec8f..63846e5fd 100644 --- a/cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp +++ b/cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp @@ -53,12 +53,12 @@ QList CardPictureToLoad::extractSetsSorted(const ExactCard &card) * PrintingInfo for the set is returned. * * This method only exists to maintain existing behavior. - * TODO: check if going through all sets is still necessary after the ExactCard refactor. * * @param card The card to look in * @param setName The set's short name * @return A PrintingInfo, or a default-constructed PrintingInfo if the set name is not in the CardInfo. */ +//! \todo Check if going through all sets is still necessary after the ExactCard refactor. static PrintingInfo findPrintingForSet(const ExactCard &card, const QString &setName) { SetToPrintingsMap setsToPrintings = card.getInfo().getSets(); diff --git a/cockatrice/src/interface/deck_loader/deck_loader.h b/cockatrice/src/interface/deck_loader/deck_loader.h index c707c33dc..ac23e1ee0 100644 --- a/cockatrice/src/interface/deck_loader/deck_loader.h +++ b/cockatrice/src/interface/deck_loader/deck_loader.h @@ -1,8 +1,8 @@ /** * @file deck_loader.h * @ingroup ImportExport - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_LOADER_H #define DECK_LOADER_H diff --git a/cockatrice/src/interface/key_signals.h b/cockatrice/src/interface/key_signals.h index 3404dca9e..30dcee0ba 100644 --- a/cockatrice/src/interface/key_signals.h +++ b/cockatrice/src/interface/key_signals.h @@ -2,8 +2,8 @@ * @file key_signals.h * @ingroup Core * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef KEYSIGNALS_H #define KEYSIGNALS_H diff --git a/cockatrice/src/interface/layouts/flow_layout.h b/cockatrice/src/interface/layouts/flow_layout.h index cc206afae..9adcd8bb5 100644 --- a/cockatrice/src/interface/layouts/flow_layout.h +++ b/cockatrice/src/interface/layouts/flow_layout.h @@ -4,6 +4,7 @@ * @brief A QLayout subclass that arranges child widgets in wrapping rows (horizontal flow) * or wrapping columns (vertical flow). */ +//! \todo Document this file. #ifndef FLOW_LAYOUT_H #define FLOW_LAYOUT_H diff --git a/cockatrice/src/interface/layouts/overlap_layout.cpp b/cockatrice/src/interface/layouts/overlap_layout.cpp index 9bf5e8468..a4c13518a 100644 --- a/cockatrice/src/interface/layouts/overlap_layout.cpp +++ b/cockatrice/src/interface/layouts/overlap_layout.cpp @@ -223,7 +223,7 @@ void OverlapLayout::setGeometry(const QRect &rect) const int yPos = rect.top() + currentRow * (maxItemHeight - overlapOffsetHeight); item->setGeometry(QRect(xPos, yPos, maxItemWidth, maxItemHeight)); - // TODO: Figure this out properly or maybe adjust size hint to account for this? + //! \todo Figure this out properly or maybe adjust size hint to account for this. // Update row and column indices based on the layout direction. if (overlapDirection == Qt::Horizontal) { currentColumn++; diff --git a/cockatrice/src/interface/layouts/overlap_layout.h b/cockatrice/src/interface/layouts/overlap_layout.h index 5844fca41..c1b6a8e51 100644 --- a/cockatrice/src/interface/layouts/overlap_layout.h +++ b/cockatrice/src/interface/layouts/overlap_layout.h @@ -1,8 +1,8 @@ /** * @file overlap_layout.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef OVERLAP_LAYOUT_H #define OVERLAP_LAYOUT_H diff --git a/cockatrice/src/interface/logger.h b/cockatrice/src/interface/logger.h index 59244e226..fc6dd70be 100644 --- a/cockatrice/src/interface/logger.h +++ b/cockatrice/src/interface/logger.h @@ -1,8 +1,8 @@ /** * @file logger.h * @ingroup Core - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef LOGGER_H #define LOGGER_H diff --git a/cockatrice/src/interface/pixel_map_generator.h b/cockatrice/src/interface/pixel_map_generator.h index 36d1e45f3..22f44d8db 100644 --- a/cockatrice/src/interface/pixel_map_generator.h +++ b/cockatrice/src/interface/pixel_map_generator.h @@ -1,8 +1,8 @@ /** * @file pixel_map_generator.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PIXMAPGENERATOR_H #define PIXMAPGENERATOR_H diff --git a/cockatrice/src/interface/theme_manager.cpp b/cockatrice/src/interface/theme_manager.cpp index abdc02eef..086845fe6 100644 --- a/cockatrice/src/interface/theme_manager.cpp +++ b/cockatrice/src/interface/theme_manager.cpp @@ -92,7 +92,7 @@ struct PaletteColorInfo ThemeManager::ThemeManager(QObject *parent) : QObject(parent) { defaultStyleName = qApp->style()->objectName(); - // FIXME workaround for windows11 style being broken + //! \todo Workaround for windows11 style being broken. if (defaultStyleName == "windows11") { defaultStyleName = "windowsvista"; } diff --git a/cockatrice/src/interface/theme_manager.h b/cockatrice/src/interface/theme_manager.h index 4b1fd2026..b9e764d08 100644 --- a/cockatrice/src/interface/theme_manager.h +++ b/cockatrice/src/interface/theme_manager.h @@ -1,8 +1,8 @@ /** * @file theme_manager.h * @ingroup CoreSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef THEMEMANAGER_H #define THEMEMANAGER_H diff --git a/cockatrice/src/interface/widgets/cards/additional_info/color_identity_widget.h b/cockatrice/src/interface/widgets/cards/additional_info/color_identity_widget.h index 6512ba890..f776d4c77 100644 --- a/cockatrice/src/interface/widgets/cards/additional_info/color_identity_widget.h +++ b/cockatrice/src/interface/widgets/cards/additional_info/color_identity_widget.h @@ -1,8 +1,8 @@ /** * @file color_identity_widget.h * @ingroup CardExtraInfoWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COLOR_IDENTITY_WIDGET_H #define COLOR_IDENTITY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/additional_info/mana_cost_widget.h b/cockatrice/src/interface/widgets/cards/additional_info/mana_cost_widget.h index 26a186c59..b2f6b62c0 100644 --- a/cockatrice/src/interface/widgets/cards/additional_info/mana_cost_widget.h +++ b/cockatrice/src/interface/widgets/cards/additional_info/mana_cost_widget.h @@ -1,8 +1,8 @@ /** * @file mana_cost_widget.h * @ingroup CardExtraInfoWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MANA_COST_WIDGET_H #define MANA_COST_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/additional_info/mana_symbol_widget.h b/cockatrice/src/interface/widgets/cards/additional_info/mana_symbol_widget.h index 8d2c6813f..0f2d7acd1 100644 --- a/cockatrice/src/interface/widgets/cards/additional_info/mana_symbol_widget.h +++ b/cockatrice/src/interface/widgets/cards/additional_info/mana_symbol_widget.h @@ -1,8 +1,8 @@ /** * @file mana_symbol_widget.h * @ingroup CardExtraInfoWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MANA_SYMBOL_WIDGET_H #define MANA_SYMBOL_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_group_display_widgets/card_group_display_widget.h b/cockatrice/src/interface/widgets/cards/card_group_display_widgets/card_group_display_widget.h index 0f1209b29..848bebb7e 100644 --- a/cockatrice/src/interface/widgets/cards/card_group_display_widgets/card_group_display_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_group_display_widgets/card_group_display_widget.h @@ -1,8 +1,8 @@ /** * @file card_group_display_widget.h * @ingroup DeckEditorCardGroupWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_GROUP_DISPLAY_WIDGET_H #define CARD_GROUP_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_group_display_widgets/flat_card_group_display_widget.h b/cockatrice/src/interface/widgets/cards/card_group_display_widgets/flat_card_group_display_widget.h index e07152b34..0772c1ab4 100644 --- a/cockatrice/src/interface/widgets/cards/card_group_display_widgets/flat_card_group_display_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_group_display_widgets/flat_card_group_display_widget.h @@ -1,8 +1,8 @@ /** * @file flat_card_group_display_widget.h * @ingroup DeckEditorCardGroupWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef FLAT_CARD_GROUP_DISPLAY_WIDGET_H #define FLAT_CARD_GROUP_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_group_display_widgets/overlapped_card_group_display_widget.h b/cockatrice/src/interface/widgets/cards/card_group_display_widgets/overlapped_card_group_display_widget.h index 288e46129..5b4b80d6b 100644 --- a/cockatrice/src/interface/widgets/cards/card_group_display_widgets/overlapped_card_group_display_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_group_display_widgets/overlapped_card_group_display_widget.h @@ -1,8 +1,8 @@ /** * @file overlapped_card_group_display_widget.h * @ingroup DeckEditorCardGroupWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef OVERLAPPED_CARD_GROUP_DISPLAY_WIDGET_H #define OVERLAPPED_CARD_GROUP_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_display_widget.h b/cockatrice/src/interface/widgets/cards/card_info_display_widget.h index d44c4c205..f8f33f3d4 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_display_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_display_widget.h @@ -1,8 +1,8 @@ /** * @file card_info_display_widget.h * @ingroup CardWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDINFOWIDGET_H #define CARDINFOWIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_frame_widget.h b/cockatrice/src/interface/widgets/cards/card_info_frame_widget.h index 11b991e87..e766fac7a 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_frame_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_frame_widget.h @@ -1,8 +1,8 @@ /** * @file card_info_frame_widget.h * @ingroup CardWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDFRAME_H #define CARDFRAME_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_picture_art_crop_widget.h b/cockatrice/src/interface/widgets/cards/card_info_picture_art_crop_widget.h index 0185f758c..ce22a1a44 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_picture_art_crop_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_picture_art_crop_widget.h @@ -1,8 +1,8 @@ /** * @file card_info_picture_art_crop_widget.h * @ingroup CardWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_INFO_PICTURE_ART_CROP_WIDGET_H #define CARD_INFO_PICTURE_ART_CROP_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_picture_enlarged_widget.h b/cockatrice/src/interface/widgets/cards/card_info_picture_enlarged_widget.h index 10eb32940..a158ac6cf 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_picture_enlarged_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_picture_enlarged_widget.h @@ -2,8 +2,8 @@ * @file card_info_picture_enlarged_widget.h * @ingroup CardWigets * @ingroup DeckEditorWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_PICTURE_ENLARGED_WIDGET_H #define CARD_PICTURE_ENLARGED_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_picture_widget.h b/cockatrice/src/interface/widgets/cards/card_info_picture_widget.h index 5eb2d88d9..bfa6584b1 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_picture_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_picture_widget.h @@ -1,8 +1,8 @@ /** * @file card_info_picture_widget.h * @ingroup CardWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_INFO_PICTURE_H #define CARD_INFO_PICTURE_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_picture_with_text_overlay_widget.h b/cockatrice/src/interface/widgets/cards/card_info_picture_with_text_overlay_widget.h index eed827292..0cc7e501c 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_picture_with_text_overlay_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_picture_with_text_overlay_widget.h @@ -2,8 +2,8 @@ * @file card_info_picture_with_text_overlay_widget.h * @ingroup CardWidgets * @ingroup DeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_PICTURE_WITH_TEXT_OVERLAY_H #define CARD_PICTURE_WITH_TEXT_OVERLAY_H diff --git a/cockatrice/src/interface/widgets/cards/card_info_text_widget.h b/cockatrice/src/interface/widgets/cards/card_info_text_widget.h index 95b588882..a9c29da37 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_text_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_text_widget.h @@ -1,8 +1,8 @@ /** * @file card_info_text_widget.h * @ingroup CardWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDINFOTEXT_H #define CARDINFOTEXT_H diff --git a/cockatrice/src/interface/widgets/cards/card_size_widget.h b/cockatrice/src/interface/widgets/cards/card_size_widget.h index 638c263ea..9f4c165fd 100644 --- a/cockatrice/src/interface/widgets/cards/card_size_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_size_widget.h @@ -3,8 +3,8 @@ * @ingroup CardWidgets * @ingroup DeckEditorWidgets * @ingroup DeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_SIZE_WIDGET_H #define CARD_SIZE_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/deck_card_zone_display_widget.h b/cockatrice/src/interface/widgets/cards/deck_card_zone_display_widget.h index dc0f3d734..074a77e53 100644 --- a/cockatrice/src/interface/widgets/cards/deck_card_zone_display_widget.h +++ b/cockatrice/src/interface/widgets/cards/deck_card_zone_display_widget.h @@ -1,8 +1,8 @@ /** * @file deck_card_zone_display_widget.h * @ingroup DeckEditorWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_CARD_ZONE_DISPLAY_WIDGET_H #define DECK_CARD_ZONE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/cards/deck_preview_card_picture_widget.h b/cockatrice/src/interface/widgets/cards/deck_preview_card_picture_widget.h index acb67a49a..154e938aa 100644 --- a/cockatrice/src/interface/widgets/cards/deck_preview_card_picture_widget.h +++ b/cockatrice/src/interface/widgets/cards/deck_preview_card_picture_widget.h @@ -2,8 +2,8 @@ * @file deck_preview_card_picture_widget.h * @ingroup CardWidgets * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_CARD_PICTURE_WIDGET_H #define DECK_PREVIEW_CARD_PICTURE_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_base/mana_base_widget.h b/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_base/mana_base_widget.h index 39380c07e..85b2a13b3 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_base/mana_base_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_base/mana_base_widget.h @@ -1,8 +1,8 @@ /** * @file mana_base_widget.h * @ingroup DeckEditorAnalyticsWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MANA_BASE_WIDGET_H #define MANA_BASE_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_curve/mana_curve_widget.h b/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_curve/mana_curve_widget.h index da59da9a8..d3e56d44c 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_curve/mana_curve_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_curve/mana_curve_widget.h @@ -1,8 +1,8 @@ /** * @file mana_curve_widget.h * @ingroup DeckEditorAnalyticsWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MANA_CURVE_WIDGET_H #define MANA_CURVE_WIDGET_H @@ -37,7 +37,7 @@ public: { config = ManaCurveConfig::fromJson(o); updateDisplay(); - }; + } QJsonObject extractConfigFromDialog(QDialog *dlg) const override; diff --git a/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_devotion/mana_devotion_widget.h b/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_devotion/mana_devotion_widget.h index 833f12938..af0215305 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_devotion/mana_devotion_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/analyzer_modules/mana_devotion/mana_devotion_widget.h @@ -1,8 +1,8 @@ /** * @file mana_devotion_widget.h * @ingroup DeckEditorAnalyticsWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MANA_DEVOTION_WIDGET_H #define MANA_DEVOTION_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.cpp b/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.cpp index 25d9db079..f751fa225 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.cpp +++ b/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.cpp @@ -531,7 +531,7 @@ void DeckEditorDeckDockWidget::changeSelectedCard(int changeBy) // currentIndex will return an index for the underlying deckModel instead of the proxy. // That index will return an invalid index when indexBelow/indexAbove crosses a header node, // causing the selection to fail to move down. - /// \todo Figure out why it's happening so we can do a proper fix instead of a hacky workaround + //! \todo Figure out why it's happening so we can do a proper fix instead of a hacky workaround. if (deckViewCurrentIndex.model() == proxy->sourceModel()) { deckViewCurrentIndex = proxy->mapFromSource(deckViewCurrentIndex); } @@ -635,8 +635,8 @@ void DeckEditorDeckDockWidget::actSwapSelection() { auto selectedRows = getSelectedCardNodeSourceIndices(); - // hack to maintain the old reselection behavior when currently selected row of a single-selection gets deleted - // TODO: remove the hack and also handle reselection when all rows of a multi-selection gets deleted + //! \todo Remove the hack and also handle reselection when all rows of a multi-selection gets deleted. + // Hack: maintains old reselection behavior when single-selection row is deleted. if (selectedRows.length() == 1) { deckView->setSelectionMode(QAbstractItemView::SingleSelection); } @@ -666,8 +666,8 @@ void DeckEditorDeckDockWidget::actDecrementSelection() { auto selectedRows = getSelectedCardNodeSourceIndices(); - // hack to maintain the old reselection behavior when currently selected row of a single-selection gets deleted - // TODO: remove the hack and also handle reselection when all rows of a multi-selection gets deleted + //! \todo Remove the hack and also handle reselection when all rows of a multi-selection gets deleted. + // Hack: maintains old reselection behavior when single-selection row is deleted. if (selectedRows.length() == 1) { deckView->setSelectionMode(QAbstractItemView::SingleSelection); } @@ -683,8 +683,8 @@ void DeckEditorDeckDockWidget::actRemoveCard() { auto selectedRows = getSelectedCardNodeSourceIndices(); - // hack to maintain the old reselection behavior when currently selected row of a single-selection gets deleted - // TODO: remove the hack and also handle reselection when all rows of a multi-selection gets deleted + //! \todo Remove the hack and also handle reselection when all rows of a multi-selection gets deleted. + // Hack: maintains old reselection behavior when single-selection row is deleted. if (selectedRows.length() == 1) { deckView->setSelectionMode(QAbstractItemView::SingleSelection); } diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_state_manager.h b/cockatrice/src/interface/widgets/deck_editor/deck_state_manager.h index 4f1ec7e04..10312d0a0 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_state_manager.h +++ b/cockatrice/src/interface/widgets/deck_editor/deck_state_manager.h @@ -154,9 +154,11 @@ public: */ QModelIndex modifyDeck(const QString &reason, const std::function &operation); - /// @name Metadata setters - /// @brief These methods set the metadata. Will no-op if the new value is the same as the current value. - /// Saves the operation to history if successful. + /** + * @name Metadata setters + * @brief These methods set the metadata. Will no-op if the new value is the same as the current value. + * Saves the operation to history if successful. + */ ///@{ void setName(const QString &name); void setComments(const QString &comments); diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_connect.h b/cockatrice/src/interface/widgets/dialogs/dlg_connect.h index 41993e068..083dad0ad 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_connect.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_connect.h @@ -1,8 +1,8 @@ /** * @file dlg_connect.h * @ingroup ConnectionDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_CONNECT_H #define DLG_CONNECT_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h b/cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h index 61eea1d6e..6642ad8c6 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_convert_deck_to_cod_format.h @@ -2,8 +2,8 @@ * @file dlg_convert_deck_to_cod_format.h * @ingroup LocalDeckStorageDialogs * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DIALOG_CONVERT_DECK_TO_COD_FORMAT_H #define DIALOG_CONVERT_DECK_TO_COD_FORMAT_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_create_game.h b/cockatrice/src/interface/widgets/dialogs/dlg_create_game.h index e28363311..61925286d 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_create_game.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_create_game.h @@ -1,8 +1,8 @@ /** * @file dlg_create_game.h * @ingroup RoomDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_CREATEGAME_H #define DLG_CREATEGAME_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h b/cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h index 27af74105..e584d0731 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_default_tags_editor.h @@ -2,8 +2,8 @@ * @file dlg_default_tags_editor.h * @ingroup Dialogs * @ingroup DeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_DEFAULT_TAGS_EDITOR_H #define DLG_DEFAULT_TAGS_EDITOR_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h b/cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h index 641b736dc..d635ac2a8 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_avatar.h @@ -1,8 +1,8 @@ /** * @file dlg_edit_avatar.h * @ingroup AccountDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_EDITAVATAR_H #define DLG_EDITAVATAR_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp b/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp index e3bbc7435..cdd4433a7 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp +++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.cpp @@ -59,7 +59,7 @@ DlgEditPassword::DlgEditPassword(QWidget *parent) : QDialog(parent) void DlgEditPassword::actOk() { - //! \todo this stuff should be using qvalidators + //! \todo This stuff should be using QValidators. if (newPasswordEdit->text().length() < 8) { QMessageBox::critical(this, tr("Error"), tr("Your password is too short.")); return; diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h b/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h index ee8e45985..85c72233d 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_password.h @@ -1,8 +1,8 @@ /** * @file dlg_edit_password.h * @ingroup AccountDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_EDITPASSWORD_H #define DLG_EDITPASSWORD_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h b/cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h index f19646756..202212e98 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_tokens.h @@ -1,8 +1,8 @@ /** * @file dlg_edit_tokens.h * @ingroup GameDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_EDIT_TOKENS_H #define DLG_EDIT_TOKENS_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h b/cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h index b89a3be04..35a8bfb46 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_edit_user.h @@ -1,8 +1,8 @@ /** * @file dlg_edit user.h * @ingroup NetworkDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_EDITUSER_H #define DLG_EDITUSER_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h b/cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h index c4cc2dd60..447f9b16c 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h @@ -1,8 +1,8 @@ /** * @file dlg_filter_games.h * @ingroup RoomDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_FILTER_GAMES_H #define DLG_FILTER_GAMES_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h index e8925b1d3..d32e2fc3e 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_challenge.h @@ -1,8 +1,8 @@ /** * @file dlg_forgot_password_challenge.h * @ingroup AccountDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_FORGOTPASSWORDCHALLENGE_H #define DLG_FORGOTPASSWORDCHALLENGE_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h index e51dad810..2cf352e0d 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_request.h @@ -1,8 +1,8 @@ /** * @file dlg_forgot_password_request.h * @ingroup AccountDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_FORGOTPASSWORDREQUEST_H #define DLG_FORGOTPASSWORDREQUEST_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp index c9c41722e..d2eb081d1 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp +++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.cpp @@ -121,7 +121,7 @@ void DlgForgotPasswordReset::actOk() return; } - //! \todo this stuff should be using qvalidators + //! \todo This stuff should be using QValidators. if (newpasswordEdit->text().length() < 8) { QMessageBox::critical(this, tr("Error"), tr("Your password is too short.")); return; diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h index 3d110c71d..8a443b906 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_forgot_password_reset.h @@ -1,8 +1,8 @@ /** * @file dlg_forgot_password_reset.h * @ingroup AccountDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_FORGOTPASSWORDRESET_H #define DLG_FORGOTPASSWORDRESET_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h index b103f6a56..27d658902 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck.h @@ -2,8 +2,8 @@ * @file dlg_load_deck.h * @ingroup LocalDeckStorageDialogs * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_LOAD_DECK_H #define DLG_LOAD_DECK_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h index 0e59653ea..dce9d712c 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_clipboard.h @@ -2,8 +2,8 @@ * @file dlg_load_deck_from_clipboard.h * @ingroup LocalDeckStorageDialogs * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_LOAD_DECK_FROM_CLIPBOARD_H #define DLG_LOAD_DECK_FROM_CLIPBOARD_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h index 1ac98d206..2890148b9 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_deck_from_website.h @@ -2,8 +2,8 @@ * @file dlg_load_deck_from_website.h * @ingroup RemoteDeckStorageDialogs * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_LOAD_DECK_FROM_WEBSITE_H #define DLG_LOAD_DECK_FROM_WEBSITE_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h b/cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h index b7e0d7aa3..9c81e9ae3 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_load_remote_deck.h @@ -2,8 +2,8 @@ * @file dlg_load_remote_deck.h * @ingroup RemoteDeckStorageDialogs * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_STARTGAME_H #define DLG_STARTGAME_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h b/cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h index d9b77a76e..2ed5eca0f 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_manage_sets.h @@ -1,8 +1,8 @@ /** * @file dlg_manage_sets.h * @ingroup Dialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_MANAGE_SETS_H #define DLG_MANAGE_SETS_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_register.cpp b/cockatrice/src/interface/widgets/dialogs/dlg_register.cpp index 7b84a9a06..0f7c17b18 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_register.cpp +++ b/cockatrice/src/interface/widgets/dialogs/dlg_register.cpp @@ -357,7 +357,7 @@ DlgRegister::DlgRegister(QWidget *parent) : QDialog(parent) void DlgRegister::actOk() { - //! \todo this stuff should be using qvalidators + //! \todo This stuff should be using QValidators. if (passwordEdit->text().length() < 8) { QMessageBox::critical(this, tr("Registration Warning"), tr("Your password is too short.")); return; diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_register.h b/cockatrice/src/interface/widgets/dialogs/dlg_register.h index bebbfc500..abed9ff51 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_register.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_register.h @@ -1,8 +1,8 @@ /** * @file dlg_register.h * @ingroup AccountDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_REGISTER_H #define DLG_REGISTER_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h b/cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h index 795366b57..92f285aa0 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_select_set_for_cards.h @@ -1,8 +1,8 @@ /** * @file dlg_select_set_for_cards.h * @ingroup Dialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_SELECT_SET_FOR_CARDS_H #define DLG_SELECT_SET_FOR_CARDS_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp b/cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp index 3f133c5b6..ff42596ea 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp +++ b/cockatrice/src/interface/widgets/dialogs/dlg_settings.cpp @@ -206,7 +206,7 @@ void DlgSettings::closeEvent(QCloseEvent *event) } if (!QDir(SettingsCache::instance().getDeckPath()).exists() || SettingsCache::instance().getDeckPath().isEmpty()) { - //! \todo Prompt to create it + //! \todo Prompt to create the deck directory. if (QMessageBox::critical( this, tr("Error"), tr("The path to your deck directory is invalid. Would you like to go back and set the correct path?"), @@ -217,7 +217,7 @@ void DlgSettings::closeEvent(QCloseEvent *event) } if (!QDir(SettingsCache::instance().getPicsPath()).exists() || SettingsCache::instance().getPicsPath().isEmpty()) { - //! \todo Prompt to create it + //! \todo Prompt to create the pictures directory. if (QMessageBox::critical(this, tr("Error"), tr("The path to your card pictures directory is invalid. Would you like to go back " "and set the correct path?"), diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_settings.h b/cockatrice/src/interface/widgets/dialogs/dlg_settings.h index f228bde92..3ffee6388 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_settings.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_settings.h @@ -1,8 +1,8 @@ /** * @file dlg_settings.h * @ingroup Dialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_SETTINGS_H #define DLG_SETTINGS_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h b/cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h index 44fc59d58..d26610983 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_startup_card_check.h @@ -1,8 +1,8 @@ /** * @file dlg_startup_card_check.h * @ingroup CardDatabaseUpdateDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_STARTUP_CARD_CHECK_H #define DLG_STARTUP_CARD_CHECK_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h b/cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h index 3dad7c652..e493481d0 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_tip_of_the_day.h @@ -1,8 +1,8 @@ /** * @file dlg_tip_of_the_day.h * @ingroup Dialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_TIPOFDAY_H #define DLG_TIPOFDAY_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_update.cpp b/cockatrice/src/interface/widgets/dialogs/dlg_update.cpp index 417dcb3eb..15735168f 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_update.cpp +++ b/cockatrice/src/interface/widgets/dialogs/dlg_update.cpp @@ -40,7 +40,7 @@ DlgUpdate::DlgUpdate(QWidget *parent) : QDialog(parent) buttonBox->addButton(ok, QDialogButtonBox::AcceptRole); connect(gotoDownload, &QPushButton::clicked, this, &DlgUpdate::gotoDownloadPage); - // TODO: make reinstall button actually do something when clicked + //! \todo Make reinstall button actually do something when clicked. // connect(manualDownload, &QPushButton::clicked, this, &DlgUpdate::downloadUpdate); connect(stopDownload, &QPushButton::clicked, this, &DlgUpdate::cancelDownload); connect(ok, &QPushButton::clicked, this, &DlgUpdate::closeDialog); diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_update.h b/cockatrice/src/interface/widgets/dialogs/dlg_update.h index daf0b9e47..7bd0020d5 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_update.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_update.h @@ -1,8 +1,8 @@ /** * @file dlg_update.h * @ingroup ClientUpdateDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_UPDATE_H #define DLG_UPDATE_H diff --git a/cockatrice/src/interface/widgets/dialogs/dlg_view_log.h b/cockatrice/src/interface/widgets/dialogs/dlg_view_log.h index f0b900527..5c7315b50 100644 --- a/cockatrice/src/interface/widgets/dialogs/dlg_view_log.h +++ b/cockatrice/src/interface/widgets/dialogs/dlg_view_log.h @@ -1,8 +1,8 @@ /** * @file dlg_view_log.h * @ingroup ServerLogDialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DLG_VIEWLOG_H #define DLG_VIEWLOG_H diff --git a/cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h b/cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h index d61fddab5..9cda07e2b 100644 --- a/cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h +++ b/cockatrice/src/interface/widgets/dialogs/tip_of_the_day.h @@ -1,8 +1,8 @@ /** * @file tip_of_the_day.h * @ingroup Dialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TIP_OF_DAY_H #define TIP_OF_DAY_H diff --git a/cockatrice/src/interface/widgets/general/background_sources.h b/cockatrice/src/interface/widgets/general/background_sources.h index 04cafe830..423111bb6 100644 --- a/cockatrice/src/interface/widgets/general/background_sources.h +++ b/cockatrice/src/interface/widgets/general/background_sources.h @@ -1,8 +1,8 @@ /** * @file background_sources.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_BACKGROUND_SOURCES_H #define COCKATRICE_BACKGROUND_SOURCES_H diff --git a/cockatrice/src/interface/widgets/general/display/banner_widget.h b/cockatrice/src/interface/widgets/general/display/banner_widget.h index 8a81dcfce..77a05abb6 100644 --- a/cockatrice/src/interface/widgets/general/display/banner_widget.h +++ b/cockatrice/src/interface/widgets/general/display/banner_widget.h @@ -3,8 +3,8 @@ * @ingroup Widgets * @ingroup DeckEditorCardGroupWidgets * @ingroup DeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef BANNER_WIDGET_H #define BANNER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/display/charts/bars/bar_widget.h b/cockatrice/src/interface/widgets/general/display/charts/bars/bar_widget.h index 67ad24995..05814f15b 100644 --- a/cockatrice/src/interface/widgets/general/display/charts/bars/bar_widget.h +++ b/cockatrice/src/interface/widgets/general/display/charts/bars/bar_widget.h @@ -2,8 +2,8 @@ * @file bar_widget.h * @ingroup Widgets * @ingroup DeckEditorAnalyticsWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef BAR_WIDGET_H #define BAR_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/display/charts/bars/color_bar.h b/cockatrice/src/interface/widgets/general/display/charts/bars/color_bar.h index 0ef68f578..100f95310 100644 --- a/cockatrice/src/interface/widgets/general/display/charts/bars/color_bar.h +++ b/cockatrice/src/interface/widgets/general/display/charts/bars/color_bar.h @@ -99,13 +99,13 @@ protected: void mouseMoveEvent(QMouseEvent *event) override; private: - /// Map of color keys to counts used for rendering. + /** @brief Map of color keys to counts used for rendering. */ QList> colors; - /// True if the mouse is currently inside the widget. + /** @brief True if the mouse is currently inside the widget. */ bool isHovered = false; - /// Minimum ratio a segment must exceed to be drawn. + /** @brief Minimum ratio a segment must exceed to be drawn. */ double minRatioThreshold = 0.0; /** diff --git a/cockatrice/src/interface/widgets/general/display/charts/bars/percent_bar_widget.h b/cockatrice/src/interface/widgets/general/display/charts/bars/percent_bar_widget.h index ff7d91363..9cd6039c8 100644 --- a/cockatrice/src/interface/widgets/general/display/charts/bars/percent_bar_widget.h +++ b/cockatrice/src/interface/widgets/general/display/charts/bars/percent_bar_widget.h @@ -2,8 +2,8 @@ * @file percent_bar_widget.h * @ingroup Widgets * @ingroup DeckEditorAnalyticsWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PERCENT_BAR_WIDGET_H #define PERCENT_BAR_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/display/dynamic_font_size_label.h b/cockatrice/src/interface/widgets/general/display/dynamic_font_size_label.h index ca3043d10..c9b159b02 100644 --- a/cockatrice/src/interface/widgets/general/display/dynamic_font_size_label.h +++ b/cockatrice/src/interface/widgets/general/display/dynamic_font_size_label.h @@ -1,8 +1,8 @@ /** * @file dynamic_font_size_label.h * @ingroup Widgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DYNAMICFONTSIZELABEL_H #define DYNAMICFONTSIZELABEL_H diff --git a/cockatrice/src/interface/widgets/general/display/dynamic_font_size_push_button.h b/cockatrice/src/interface/widgets/general/display/dynamic_font_size_push_button.h index 19e67fd28..540abfe6b 100644 --- a/cockatrice/src/interface/widgets/general/display/dynamic_font_size_push_button.h +++ b/cockatrice/src/interface/widgets/general/display/dynamic_font_size_push_button.h @@ -1,8 +1,8 @@ /** * @file dynamic_font_size_push_button.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DYNAMICFONTSIZEPUSHBUTTON_H #define DYNAMICFONTSIZEPUSHBUTTON_H diff --git a/cockatrice/src/interface/widgets/general/display/labeled_input.h b/cockatrice/src/interface/widgets/general/display/labeled_input.h index 8424e09f0..838dfb280 100644 --- a/cockatrice/src/interface/widgets/general/display/labeled_input.h +++ b/cockatrice/src/interface/widgets/general/display/labeled_input.h @@ -1,8 +1,8 @@ /** * @file labeled_input.h * @ingroup DeckEditorCardGroupWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef LABELED_INPUT_H #define LABELED_INPUT_H diff --git a/cockatrice/src/interface/widgets/general/display/shadow_background_label.h b/cockatrice/src/interface/widgets/general/display/shadow_background_label.h index b2344b7d0..69232691e 100644 --- a/cockatrice/src/interface/widgets/general/display/shadow_background_label.h +++ b/cockatrice/src/interface/widgets/general/display/shadow_background_label.h @@ -1,8 +1,8 @@ /** * @file shadow_background_label.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef STYLEDLABEL_H #define STYLEDLABEL_H diff --git a/cockatrice/src/interface/widgets/general/home_styled_button.h b/cockatrice/src/interface/widgets/general/home_styled_button.h index a053993da..f8d97e9aa 100644 --- a/cockatrice/src/interface/widgets/general/home_styled_button.h +++ b/cockatrice/src/interface/widgets/general/home_styled_button.h @@ -1,8 +1,8 @@ /** * @file home_styled_button.h * @ingroup Widgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef HOME_STYLED_BUTTON_H #define HOME_STYLED_BUTTON_H diff --git a/cockatrice/src/interface/widgets/general/home_widget.h b/cockatrice/src/interface/widgets/general/home_widget.h index b30bb5407..90d003aa7 100644 --- a/cockatrice/src/interface/widgets/general/home_widget.h +++ b/cockatrice/src/interface/widgets/general/home_widget.h @@ -2,8 +2,8 @@ * @file home_widget.h * @ingroup Core * @ingroup Widgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef HOME_WIDGET_H #define HOME_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h b/cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h index 1932ce70a..a232336d8 100644 --- a/cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h +++ b/cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h @@ -3,6 +3,7 @@ * @ingroup UI * @brief A QWidget that wraps a FlowLayout inside an optional QScrollArea. */ +//! \todo Document this file. #ifndef FLOW_WIDGET_H #define FLOW_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.cpp b/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.cpp index 2fd6cd6b8..97068978d 100644 --- a/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.cpp +++ b/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.cpp @@ -33,7 +33,7 @@ OverlapControlWidget::OverlapControlWidget(int overlapPercentage, layout->addWidget(overlap_percentage_input); layout->addWidget(overlap_direction); - // TODO probably connect this to the parent + //! \todo Probably connect this to the parent. // connect(card_size_slider, &QSlider::valueChanged, display, &CardPicture::setScaleFactor); } diff --git a/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.h b/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.h index b2c19a07f..104a97da9 100644 --- a/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.h +++ b/cockatrice/src/interface/widgets/general/layout_containers/overlap_control_widget.h @@ -1,8 +1,8 @@ /** * @file overlap_control_widget.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef OVERLAP_CONTROL_WIDGET_H #define OVERLAP_CONTROL_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h b/cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h index 9ac6ac80e..62c620201 100644 --- a/cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h +++ b/cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h @@ -1,8 +1,8 @@ /** * @file overlap_widget.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef OVERLAP_WIDGET_H #define OVERLAP_WIDGET_H diff --git a/cockatrice/src/interface/widgets/menus/deck_editor_menu.h b/cockatrice/src/interface/widgets/menus/deck_editor_menu.h index ac8f3b787..eff9257bb 100644 --- a/cockatrice/src/interface/widgets/menus/deck_editor_menu.h +++ b/cockatrice/src/interface/widgets/menus/deck_editor_menu.h @@ -1,8 +1,8 @@ /** * @file deck_editor_menu.h * @ingroup DeckEditors - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_EDITOR_MENU_H #define DECK_EDITOR_MENU_H diff --git a/cockatrice/src/interface/widgets/menus/tearoff_menu.h b/cockatrice/src/interface/widgets/menus/tearoff_menu.h index 3e6c47012..ef1dfbcb3 100644 --- a/cockatrice/src/interface/widgets/menus/tearoff_menu.h +++ b/cockatrice/src/interface/widgets/menus/tearoff_menu.h @@ -1,8 +1,8 @@ /** * @file tearoff_menu.h * @ingroup GameMenus - * @brief TODO: Document this. */ +//! \todo Document this file. #pragma once diff --git a/cockatrice/src/interface/widgets/printing_selector/all_zones_card_amount_widget.h b/cockatrice/src/interface/widgets/printing_selector/all_zones_card_amount_widget.h index d158d257e..05047d94f 100644 --- a/cockatrice/src/interface/widgets/printing_selector/all_zones_card_amount_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/all_zones_card_amount_widget.h @@ -2,8 +2,8 @@ * @file all_zones_card_amount_widget.h * @ingroup CardExtraInfoWidgets * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef ALL_ZONES_CARD_AMOUNT_WIDGET_H #define ALL_ZONES_CARD_AMOUNT_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h b/cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h index 3051b1691..f0f2128f0 100644 --- a/cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h @@ -2,8 +2,8 @@ * @file card_amount_widget.h * @ingroup CardExtraInfoWidgets * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_AMOUNT_WIDGET_H #define CARD_AMOUNT_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/printing_selector.h b/cockatrice/src/interface/widgets/printing_selector/printing_selector.h index f7844504d..b9e6723f2 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector.h @@ -1,8 +1,8 @@ /** * @file printing_selector.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PRINTING_SELECTOR_H #define PRINTING_SELECTOR_H diff --git a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_display_widget.h b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_display_widget.h index ac5c7c05f..b708bd973 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_display_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_display_widget.h @@ -1,8 +1,8 @@ /** * @file printing_selector_card_display_widget.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PRINTING_SELECTOR_CARD_DISPLAY_WIDGET_H #define PRINTING_SELECTOR_CARD_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_overlay_widget.h b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_overlay_widget.h index ae2307c45..2fdf5ab74 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_overlay_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_overlay_widget.h @@ -1,8 +1,8 @@ /** * @file printing_selector_card_overlay_widget.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PRINTING_SELECTOR_CARD_OVERLAY_WIDGET_H #define PRINTING_SELECTOR_CARD_OVERLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_search_widget.h b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_search_widget.h index 821addd01..3efabe13c 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_search_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_search_widget.h @@ -1,8 +1,8 @@ /** * @file printing_selector_card_search_widget.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PRINTING_SELECTOR_CARD_SEARCH_WIDGET_H #define PRINTING_SELECTOR_CARD_SEARCH_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_selection_widget.h b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_selection_widget.h index ecd5c83e3..0aa56c9d8 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_selection_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_selection_widget.h @@ -1,8 +1,8 @@ /** * @file printing_selector_card_selection_widget.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PRINTING_SELECTOR_CARD_SELECTION_WIDGET_H #define PRINTING_SELECTOR_CARD_SELECTION_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_sorting_widget.h b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_sorting_widget.h index b5a00b81e..bb5b60cdc 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_sorting_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector_card_sorting_widget.h @@ -1,8 +1,8 @@ /** * @file printing_selector_card_sorting_widget.h * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PRINTING_SELECTOR_CARD_SORTING_WIDGET_H #define PRINTING_SELECTOR_CARD_SORTING_WIDGET_H diff --git a/cockatrice/src/interface/widgets/printing_selector/set_name_and_collectors_number_display_widget.h b/cockatrice/src/interface/widgets/printing_selector/set_name_and_collectors_number_display_widget.h index 220f57256..140f190df 100644 --- a/cockatrice/src/interface/widgets/printing_selector/set_name_and_collectors_number_display_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/set_name_and_collectors_number_display_widget.h @@ -2,8 +2,8 @@ * @file set_name_and_collectors_number_display_widget.h * @ingroup CardExtraInfoWidgets * @ingroup PrintingWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SET_NAME_AND_COLLECTORS_NUMBER_DISPLAY_WIDGET_H #define SET_NAME_AND_COLLECTORS_NUMBER_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h b/cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h index 43de8183f..5dcbe059a 100644 --- a/cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h +++ b/cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h @@ -2,8 +2,8 @@ * @file settings_button_widget.h * @ingroup Widgets * @ingroup Settings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SETTINGS_BUTTON_WIDGET_H #define SETTINGS_BUTTON_WIDGET_H @@ -27,7 +27,7 @@ public: bool isCompact() const { return compact; - }; + } protected: void mousePressEvent(QMouseEvent *event) override; diff --git a/cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h b/cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h index e9605e473..01e86abfe 100644 --- a/cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h +++ b/cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h @@ -2,8 +2,8 @@ * @file settings_popup_widget.h * @ingroup Widgets * @ingroup Settings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SETTINGS_POPUP_WIDGET_H #define SETTINGS_POPUP_WIDGET_H diff --git a/cockatrice/src/interface/widgets/replay/replay_manager.h b/cockatrice/src/interface/widgets/replay/replay_manager.h index 9469adcd4..d67ae5a90 100644 --- a/cockatrice/src/interface/widgets/replay/replay_manager.h +++ b/cockatrice/src/interface/widgets/replay/replay_manager.h @@ -2,8 +2,8 @@ * @file replay_manager.h * @ingroup Core * @ingroup Replay - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef REPLAY_MANAGER_H #define REPLAY_MANAGER_H diff --git a/cockatrice/src/interface/widgets/replay/replay_timeline_widget.cpp b/cockatrice/src/interface/widgets/replay/replay_timeline_widget.cpp index 508d45666..46a3dff40 100644 --- a/cockatrice/src/interface/widgets/replay/replay_timeline_widget.cpp +++ b/cockatrice/src/interface/widgets/replay/replay_timeline_widget.cpp @@ -103,8 +103,12 @@ void ReplayTimelineWidget::skipToTime(int newTime, bool doRewindBuffering) update(); } -/// @param doRewindBuffering When true, if multiple backward skips are made in quick succession, only a single rewind -/// is processed at the end. When false, the backwards skip will always cause an immediate rewind +/** + * @brief Handles a backwards skip in the replay timeline. + * + * @param doRewindBuffering When true, if multiple backward skips are made in quick succession, only a single rewind + * is processed at the end. When false, the backwards skip will always cause an immediate rewind. + */ void ReplayTimelineWidget::handleBackwardsSkip(bool doRewindBuffering) { if (doRewindBuffering) { @@ -151,7 +155,7 @@ void ReplayTimelineWidget::replayTimerTimeout() } } -/// Processes all unprocessed events up to the current time. +/** @brief Processes all unprocessed events up to the current time. */ void ReplayTimelineWidget::processNewEvents(PlaybackMode playbackMode) { currentProcessedTime = currentVisualTime; diff --git a/cockatrice/src/interface/widgets/replay/replay_timeline_widget.h b/cockatrice/src/interface/widgets/replay/replay_timeline_widget.h index 07a0c0b4c..418d0c7e0 100644 --- a/cockatrice/src/interface/widgets/replay/replay_timeline_widget.h +++ b/cockatrice/src/interface/widgets/replay/replay_timeline_widget.h @@ -1,8 +1,8 @@ /** * @file replay_timeline_widget.h * @ingroup Replay - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef REPLAY_TIMELINE_WIDGET #define REPLAY_TIMELINE_WIDGET diff --git a/cockatrice/src/interface/widgets/server/chat_view/chat_view.cpp b/cockatrice/src/interface/widgets/server/chat_view/chat_view.cpp index 1fe77e278..ccbbe9246 100644 --- a/cockatrice/src/interface/widgets/server/chat_view/chat_view.cpp +++ b/cockatrice/src/interface/widgets/server/chat_view/chat_view.cpp @@ -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); } } diff --git a/cockatrice/src/interface/widgets/server/chat_view/chat_view.h b/cockatrice/src/interface/widgets/server/chat_view/chat_view.h index d1939fbea..c5ae2b81a 100644 --- a/cockatrice/src/interface/widgets/server/chat_view/chat_view.h +++ b/cockatrice/src/interface/widgets/server/chat_view/chat_view.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/handle_public_servers.h b/cockatrice/src/interface/widgets/server/handle_public_servers.h index f06bb3ff6..fa924b183 100644 --- a/cockatrice/src/interface/widgets/server/handle_public_servers.h +++ b/cockatrice/src/interface/widgets/server/handle_public_servers.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/remote/remote_decklist_tree_widget.h b/cockatrice/src/interface/widgets/server/remote/remote_decklist_tree_widget.h index bca46fd47..3dd91d7a4 100644 --- a/cockatrice/src/interface/widgets/server/remote/remote_decklist_tree_widget.h +++ b/cockatrice/src/interface/widgets/server/remote/remote_decklist_tree_widget.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/remote/remote_replay_list_tree_widget.h b/cockatrice/src/interface/widgets/server/remote/remote_replay_list_tree_widget.h index 6d81aefca..10e698aee 100644 --- a/cockatrice/src/interface/widgets/server/remote/remote_replay_list_tree_widget.h +++ b/cockatrice/src/interface/widgets/server/remote/remote_replay_list_tree_widget.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/user/user_context_menu.h b/cockatrice/src/interface/widgets/server/user/user_context_menu.h index 0056d74ae..b0ff89816 100644 --- a/cockatrice/src/interface/widgets/server/user/user_context_menu.h +++ b/cockatrice/src/interface/widgets/server/user/user_context_menu.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/user/user_info_box.h b/cockatrice/src/interface/widgets/server/user/user_info_box.h index d3d926bed..299deed2f 100644 --- a/cockatrice/src/interface/widgets/server/user/user_info_box.h +++ b/cockatrice/src/interface/widgets/server/user/user_info_box.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/user/user_info_connection.h b/cockatrice/src/interface/widgets/server/user/user_info_connection.h index cfba22346..6278815a9 100644 --- a/cockatrice/src/interface/widgets/server/user/user_info_connection.h +++ b/cockatrice/src/interface/widgets/server/user/user_info_connection.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/user/user_list_manager.h b/cockatrice/src/interface/widgets/server/user/user_list_manager.h index f378bd08d..f09284bd0 100644 --- a/cockatrice/src/interface/widgets/server/user/user_list_manager.h +++ b/cockatrice/src/interface/widgets/server/user/user_list_manager.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/user/user_list_proxy.h b/cockatrice/src/interface/widgets/server/user/user_list_proxy.h index bff76077f..626f89b8f 100644 --- a/cockatrice/src/interface/widgets/server/user/user_list_proxy.h +++ b/cockatrice/src/interface/widgets/server/user/user_list_proxy.h @@ -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 diff --git a/cockatrice/src/interface/widgets/server/user/user_list_widget.h b/cockatrice/src/interface/widgets/server/user/user_list_widget.h index 036837673..5a8c00d10 100644 --- a/cockatrice/src/interface/widgets/server/user/user_list_widget.h +++ b/cockatrice/src/interface/widgets/server/user/user_list_widget.h @@ -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 diff --git a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/card/archidekt_api_response_card.cpp b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/card/archidekt_api_response_card.cpp index 5b879f8ae..46c229156 100644 --- a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/card/archidekt_api_response_card.cpp +++ b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/card/archidekt_api_response_card.cpp @@ -21,16 +21,16 @@ void ArchidektApiResponseCard::fromJson(const QJsonObject &json) edition.fromJson(json.value("edition").toObject()); flavor = json.value("flavor").toString(); - //! \todo but not really important - //! \todo games = {""}; - //! \todo options = {""}; + //! \todo Parse games and options fields (not really important). + // games = {""}; + // options = {""}; scryfallImageHash = json.value("scryfallImageHash").toString(); oracleCard = json.value("oracleCard").toObject(); owned = json.value("owned").toInt(); pinnedStatus = json.value("pinnedStatus").toInt(); rarity = json.value("rarity").toString(); - //! \todo but not really important - //! \todo globalCategories = {""}; + //! \todo Parse globalCategories field (not really important). + // globalCategories = {""}; } void ArchidektApiResponseCard::debugPrint() const diff --git a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck/archidekt_api_response_deck.cpp b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck/archidekt_api_response_deck.cpp index 98d8c6c8c..a27d8d961 100644 --- a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck/archidekt_api_response_deck.cpp +++ b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck/archidekt_api_response_deck.cpp @@ -44,7 +44,7 @@ void ArchidektApiResponseDeck::fromJson(const QJsonObject &json) cards.append(entry); } - // TODO but not really important + //! \todo Parse customCards field (not really important). // customCards = {""}; } diff --git a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_listing_container.cpp b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_listing_container.cpp index 16ea60487..416621b41 100644 --- a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_listing_container.cpp +++ b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_listing_container.cpp @@ -23,7 +23,7 @@ void ArchidektApiResponseDeckListingContainer::fromJson(const QJsonObject &json) theoryCrafted = json.value("theoryCrafted").toBool(); game = json.value("game").toString(); hasDescription = json.value("hasDescription").toBool(); - // TODO + //! \todo Parse tags field. // tags = {""}; parentFolderId = json.value("parentFolderId").toInt(); owner.fromJson(json.value("owner").toObject()); diff --git a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_owner.cpp b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_owner.cpp index 2ba926f8b..3d6eac03d 100644 --- a/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_owner.cpp +++ b/cockatrice/src/interface/widgets/tabs/api/archidekt/api_response/deck_listings/archidekt_api_response_deck_owner.cpp @@ -7,7 +7,7 @@ void ArchidektApiResponseDeckOwner::fromJson(const QJsonObject &json) avatar = QUrl(json.value("avatar").toString()); moderator = json.value("moderator").toBool(); pledgeLevel = json.value("pledgeLevel").toInt(); - // TODO but not really important + //! \todo Parse roles field (not really important). // roles = {""}; } diff --git a/cockatrice/src/interface/widgets/tabs/api/archidekt/display/archidekt_api_response_deck_listings_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/archidekt/display/archidekt_api_response_deck_listings_display_widget.h index 479de5fc8..f9a887aa4 100644 --- a/cockatrice/src/interface/widgets/tabs/api/archidekt/display/archidekt_api_response_deck_listings_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/archidekt/display/archidekt_api_response_deck_listings_display_widget.h @@ -82,16 +82,16 @@ public: void resizeEvent(QResizeEvent *event) override; private: - /// Slider controlling the scale of card thumbnails in all deck entry widgets. + /** @brief Slider controlling the scale of card thumbnails in all deck entry widgets. */ CardSizeWidget *cardSizeSlider; - /// Main horizontal layout containing the FlowWidget. + /** @brief Main horizontal layout containing the FlowWidget. */ QHBoxLayout *layout; - /// Container providing scrollable multi-row flow layout of deck entries. + /** @brief Container providing scrollable multi-row flow layout of deck entries. */ FlowWidget *flowWidget; - /// Shared network manager used to download card images for all child entry widgets. + /** @brief Shared network manager used to download card images for all child entry widgets. */ QNetworkAccessManager *imageNetworkManager; }; diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h index cd4f9d99c..7bc97c431 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h @@ -1,8 +1,8 @@ /** * @file edhrec_deck_api_response.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_DECK_API_RESPONSE_H #define EDHREC_DECK_API_RESPONSE_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h index 66a407acd..bd874d067 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_prices.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H #define EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h index 07b53dd97..d76dda490 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_container.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CONTAINER_ENTRY_H #define CONTAINER_ENTRY_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h index 86d78c5e3..931850ea9 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_details.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_VIEW_H #define CARD_VIEW_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h index 15691fbe4..2df29de0c 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_list.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_LIST_H #define CARD_LIST_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h index 629eb8273..293e9a150 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h @@ -1,8 +1,8 @@ /** * @file edhrec_commander_api_response_commander_details.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H #define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h index fb89c0b12..695498e2b 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h @@ -1,8 +1,8 @@ /** * @file edhrec_top_cards_api_response.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_TOP_CARDS_API_RESPONSE_H #define EDHREC_TOP_CARDS_API_RESPONSE_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h index 26c5afedb..10aa51ff4 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h @@ -1,8 +1,8 @@ /** * @file edhrec_top_commanders_api_response.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_H #define EDHREC_TOP_COMMANDERS_API_RESPONSE_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h index 48219893a..0337d94f8 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h @@ -1,8 +1,8 @@ /** * @file edhrec_top_tags_api_response.h * @ingroup ApiResponses - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_TOP_TAGS_API_RESPONSE_H #define EDHREC_TOP_TAGS_API_RESPONSE_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h index 80d32a394..8943ae9f3 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_prices_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H #define EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h index 82dcfb8b0..5daf32412 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_details_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_DETAILS_DISPLAY_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_CARD_DETAILS_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h index 43baddb4c..516d820eb 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_inclusion_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H #define EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h index d34c3da34..555da6ecf 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_list_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_LIST_DISPLAY_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_CARD_LIST_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h index c2e1c018c..5800b5497 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_card_synergy_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H #define EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h index 8e74588e2..4201ce3b3 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_api_response_commander_details_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_DISPLAY_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h index 1678e1380..80da8a7f8 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_commander_api_response_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h index 10dfa8223..9b46b54ba 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_commander_api_response_navigation_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h index e2748bf10..30998391c 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_top_cards_api_response_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h index 766518c02..2b9563ea5 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_top_commanders_api_response_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h index 64228b85d..4a4fc8991 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h @@ -1,8 +1,8 @@ /** * @file edhrec_top_tags_api_response_display_widget.h * @ingroup ApiResponseDisplayWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec.h index b5ee8d2ca..5ce36c9cf 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec.h @@ -1,8 +1,8 @@ /** * @file tab_edhrec.h * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_EDHREC_H #define TAB_EDHREC_H diff --git a/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec_main.h b/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec_main.h index 04cf03fc1..a7ed83efd 100644 --- a/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec_main.h +++ b/cockatrice/src/interface/widgets/tabs/api/edhrec/tab_edhrec_main.h @@ -1,8 +1,8 @@ /** * @file tab_edhrec_main.h * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_EDHREC_MAIN_H #define TAB_EDHREC_MAIN_H diff --git a/cockatrice/src/interface/widgets/tabs/tab.h b/cockatrice/src/interface/widgets/tabs/tab.h index 7cff01130..6ea1f5077 100644 --- a/cockatrice/src/interface/widgets/tabs/tab.h +++ b/cockatrice/src/interface/widgets/tabs/tab.h @@ -1,8 +1,8 @@ /** * @file tab.h * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_H #define TAB_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_account.h b/cockatrice/src/interface/widgets/tabs/tab_account.h index e09c12eb2..887038ebb 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_account.h +++ b/cockatrice/src/interface/widgets/tabs/tab_account.h @@ -1,8 +1,8 @@ /** * @file tab_account.h * @ingroup AccountTabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_ACCOUNT_H #define TAB_ACCOUNT_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_admin.h b/cockatrice/src/interface/widgets/tabs/tab_admin.h index e1935e351..0da098ba5 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_admin.h +++ b/cockatrice/src/interface/widgets/tabs/tab_admin.h @@ -1,8 +1,8 @@ /** * @file tab_admin.h * @ingroup ServerTabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_ADMIN_H #define TAB_ADMIN_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_deck_storage.h b/cockatrice/src/interface/widgets/tabs/tab_deck_storage.h index f8c0497f7..a863e0625 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_deck_storage.h +++ b/cockatrice/src/interface/widgets/tabs/tab_deck_storage.h @@ -2,8 +2,8 @@ * @file tab_deck_storage.h * @ingroup DeckStorageWidgets * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_DECK_STORAGE_H #define TAB_DECK_STORAGE_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_game.h b/cockatrice/src/interface/widgets/tabs/tab_game.h index c8dfc3093..7f9392034 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_game.h +++ b/cockatrice/src/interface/widgets/tabs/tab_game.h @@ -3,8 +3,8 @@ * @ingroup Tabs * @ingroup GameWidgets * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_GAME_H #define TAB_GAME_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_home.h b/cockatrice/src/interface/widgets/tabs/tab_home.h index c40dfc269..3aae19c2b 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_home.h +++ b/cockatrice/src/interface/widgets/tabs/tab_home.h @@ -1,8 +1,8 @@ /** * @file tab_home.h * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_HOME_H #define TAB_HOME_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_logs.h b/cockatrice/src/interface/widgets/tabs/tab_logs.h index a73af651b..5d164dc92 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_logs.h +++ b/cockatrice/src/interface/widgets/tabs/tab_logs.h @@ -1,8 +1,8 @@ /** * @file tab_logs.h * @ingroup ServerTabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_LOG_H #define TAB_LOG_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_message.h b/cockatrice/src/interface/widgets/tabs/tab_message.h index 36a0b5f78..0472bb061 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_message.h +++ b/cockatrice/src/interface/widgets/tabs/tab_message.h @@ -1,8 +1,8 @@ /** * @file tab_message.h * @ingroup MessagingTabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_MESSAGE_H #define TAB_MESSAGE_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_replays.h b/cockatrice/src/interface/widgets/tabs/tab_replays.h index fa1131cd5..aa4ec039c 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_replays.h +++ b/cockatrice/src/interface/widgets/tabs/tab_replays.h @@ -2,8 +2,8 @@ * @file tab_replays.h * @ingroup Replays * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_REPLAYS_H #define TAB_REPLAYS_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_room.h b/cockatrice/src/interface/widgets/tabs/tab_room.h index 67d9afc86..eeb5a9e14 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_room.h +++ b/cockatrice/src/interface/widgets/tabs/tab_room.h @@ -2,8 +2,8 @@ * @file tab_room.h * @ingroup RoomTabs * @ingroup Lobby - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_ROOM_H #define TAB_ROOM_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_server.h b/cockatrice/src/interface/widgets/tabs/tab_server.h index f2dd8f0a2..137823592 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_server.h +++ b/cockatrice/src/interface/widgets/tabs/tab_server.h @@ -1,8 +1,8 @@ /** * @file tab_server.h * @ingroup ServerTabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_SERVER_H #define TAB_SERVER_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_supervisor.h b/cockatrice/src/interface/widgets/tabs/tab_supervisor.h index 0c4428f83..e77fb4f7b 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_supervisor.h +++ b/cockatrice/src/interface/widgets/tabs/tab_supervisor.h @@ -2,8 +2,8 @@ * @file tab_supervisor.h * @ingroup Core * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_SUPERVISOR_H #define TAB_SUPERVISOR_H diff --git a/cockatrice/src/interface/widgets/tabs/tab_visual_database_display.h b/cockatrice/src/interface/widgets/tabs/tab_visual_database_display.h index 4fe4d3e8f..f5aef6d9b 100644 --- a/cockatrice/src/interface/widgets/tabs/tab_visual_database_display.h +++ b/cockatrice/src/interface/widgets/tabs/tab_visual_database_display.h @@ -1,8 +1,8 @@ /** * @file tab_visual_database_display.h * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_VISUAL_DATABASE_DISPLAY_H #define TAB_VISUAL_DATABASE_DISPLAY_H diff --git a/cockatrice/src/interface/widgets/tabs/visual_deck_editor/tab_deck_editor_visual_tab_widget.h b/cockatrice/src/interface/widgets/tabs/visual_deck_editor/tab_deck_editor_visual_tab_widget.h index 9468df425..48dd8ea9d 100644 --- a/cockatrice/src/interface/widgets/tabs/visual_deck_editor/tab_deck_editor_visual_tab_widget.h +++ b/cockatrice/src/interface/widgets/tabs/visual_deck_editor/tab_deck_editor_visual_tab_widget.h @@ -63,19 +63,19 @@ public: CardDatabaseModel *_cardDatabaseModel, CardDatabaseDisplayModel *_cardDatabaseDisplayModel); - /// Add a new tab with a widget and title. + /** @brief Add a new tab with a widget and title. */ void addNewTab(QWidget *widget, const QString &title); - /// Remove the currently active tab. + /** @brief Remove the currently active tab. */ void removeCurrentTab(); - /// Set the title of a specific tab. + /** @brief Set the title of a specific tab. */ void setTabTitle(int index, const QString &title); - /// Get the currently active tab widget. + /** @brief Get the currently active tab widget. */ [[nodiscard]] QWidget *getCurrentTab() const; - /// Get the total number of tabs. + /** @brief Get the total number of tabs. */ [[nodiscard]] int getTabCount() const; VisualDeckEditorWidget *visualDeckView; ///< Visual deck editor widget. diff --git a/cockatrice/src/interface/widgets/tabs/visual_deck_storage/tab_deck_storage_visual.h b/cockatrice/src/interface/widgets/tabs/visual_deck_storage/tab_deck_storage_visual.h index ccf752e67..d3f64e23d 100644 --- a/cockatrice/src/interface/widgets/tabs/visual_deck_storage/tab_deck_storage_visual.h +++ b/cockatrice/src/interface/widgets/tabs/visual_deck_storage/tab_deck_storage_visual.h @@ -1,8 +1,8 @@ /** * @file tab_deck_storage_visual.h * @ingroup Tabs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef TAB_DECK_STORAGE_VISUAL_H #define TAB_DECK_STORAGE_VISUAL_H diff --git a/cockatrice/src/interface/widgets/utility/custom_line_edit.h b/cockatrice/src/interface/widgets/utility/custom_line_edit.h index 2026c1c1c..8c389b797 100644 --- a/cockatrice/src/interface/widgets/utility/custom_line_edit.h +++ b/cockatrice/src/interface/widgets/utility/custom_line_edit.h @@ -1,8 +1,8 @@ /** * @file custom_line_edit.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CUSTOMLINEEDIT_H #define CUSTOMLINEEDIT_H diff --git a/cockatrice/src/interface/widgets/utility/line_edit_completer.h b/cockatrice/src/interface/widgets/utility/line_edit_completer.h index 7b3756e3c..65fa382ac 100644 --- a/cockatrice/src/interface/widgets/utility/line_edit_completer.h +++ b/cockatrice/src/interface/widgets/utility/line_edit_completer.h @@ -1,8 +1,8 @@ /** * @file line_edit_completer.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef LINEEDITCOMPLETER_H #define LINEEDITCOMPLETER_H diff --git a/cockatrice/src/interface/widgets/utility/sequence_edit.h b/cockatrice/src/interface/widgets/utility/sequence_edit.h index a5fe1a1c6..28e18d42f 100644 --- a/cockatrice/src/interface/widgets/utility/sequence_edit.h +++ b/cockatrice/src/interface/widgets/utility/sequence_edit.h @@ -1,8 +1,8 @@ /** * @file sequence_edit.h * @ingroup UI - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SEQUENCEEDIT_H #define SEQUENCEEDIT_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_color_filter_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_color_filter_widget.h index 698ea9e97..497d25fce 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_color_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_color_filter_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_color_filter_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_COLOR_FILTER_WIDGET_H #define VISUAL_DATABASE_DISPLAY_COLOR_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_filter_save_load_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_filter_save_load_widget.h index bb5921a02..459633e42 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_filter_save_load_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_filter_save_load_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_filter_save_load_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_FILTER_SAVE_LOAD_WIDGET_H #define VISUAL_DATABASE_DISPLAY_FILTER_SAVE_LOAD_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_main_type_filter_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_main_type_filter_widget.h index 9145812a7..6dec58319 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_main_type_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_main_type_filter_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_main_type_filter_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_MAIN_TYPE_FILTER_WIDGET_H #define VISUAL_DATABASE_DISPLAY_MAIN_TYPE_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_name_filter_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_name_filter_widget.h index 76d3ec29e..5a8438a05 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_name_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_name_filter_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_name_filter_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_NAME_FILTER_WIDGET_H #define VISUAL_DATABASE_DISPLAY_NAME_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_set_filter_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_set_filter_widget.h index dc7fd0e92..bcc5e93c2 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_set_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_set_filter_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_set_filter_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_SET_FILTER_WIDGET_H #define VISUAL_DATABASE_DISPLAY_SET_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_sub_type_filter_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_sub_type_filter_widget.h index ce5546fc8..d713c7f99 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_sub_type_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_sub_type_filter_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_sub_type_filter_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_SUB_TYPE_FILTER_WIDGET_H #define VISUAL_DATABASE_DISPLAY_SUB_TYPE_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_widget.h index d4a664111..48a026d11 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_display_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_display_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_DISPLAY_WIDGET_H #define VISUAL_DATABASE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_database_display/visual_database_filter_display_widget.h b/cockatrice/src/interface/widgets/visual_database_display/visual_database_filter_display_widget.h index 05bf43118..5fe29fa2d 100644 --- a/cockatrice/src/interface/widgets/visual_database_display/visual_database_filter_display_widget.h +++ b/cockatrice/src/interface/widgets/visual_database_display/visual_database_filter_display_widget.h @@ -1,8 +1,8 @@ /** * @file visual_database_filter_display_widget.h * @ingroup VisualCardDatabaseWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DATABASE_FILTER_DISPLAY_WIDGET_H #define VISUAL_DATABASE_FILTER_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_display_options_widget.h b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_display_options_widget.h index 9930ff50b..bc11884df 100644 --- a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_display_options_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_display_options_widget.h @@ -104,37 +104,37 @@ private slots: void updateDisplayType(); private: - /// Layout for grouping and sorting UI elements. + /** @brief Layout for grouping and sorting UI elements. */ QHBoxLayout *groupAndSortLayout; - /// Current deck display type. + /** @brief Current deck display type. */ DisplayType currentDisplayType = DisplayType::Overlap; - /// Button used to toggle the display layout. + /** @brief Button used to toggle the display layout. */ CompactPushButton *displayTypeButton; - /// Label for the group-by selector. + /** @brief Label for the group-by selector. */ QLabel *groupByLabel; - /// Combo box listing group-by criteria. + /** @brief Combo box listing group-by criteria. */ QComboBox *groupByComboBox; - /// Currently active group-by criterion. + /** @brief Currently active group-by criterion. */ QString activeGroupCriteria = "maintype"; - /// Encapsulates the sort settings widgets (label + list). + /** @brief Encapsulates the sort settings widgets (label + list). */ SettingsButtonWidget *sortCriteriaButton; - /// Label for “Sort by”. + /** @brief Label for "Sort by". */ QLabel *sortByLabel; - /// Descriptive label inside the sort criteria button. + /** @brief Descriptive label inside the sort criteria button. */ QLabel *sortLabel; - /// Draggable list of sort criteria. + /** @brief Draggable list of sort criteria. */ QListWidget *sortByListWidget; - /// Ordered list of current sort criteria. + /** @brief Ordered list of current sort criteria. */ QStringList activeSortCriteria = {"name", "cmc", "colors", "maintype"}; }; diff --git a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_sample_hand_widget.h b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_sample_hand_widget.h index c63c74a4d..c6c07dd55 100644 --- a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_sample_hand_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_sample_hand_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_editor_sample_hand_widget.h * @ingroup DeckEditorAnalyticsWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_EDITOR_SAMPLE_HAND_WIDGET_H #define VISUAL_DECK_EDITOR_SAMPLE_HAND_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.cpp b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.cpp index 971498af1..4a67edcd1 100644 --- a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.cpp +++ b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.cpp @@ -418,7 +418,7 @@ void VisualDeckEditorWidget::onHover(const ExactCard &hoveredCard) // If nothing is selected -> this is our "active/preview" card emit activeCardChanged(hoveredCard); - // TODO: highlight hovered card visually: + //! \todo Highlight hovered card visually. // highlightHoveredCard(hoveredCard); } @@ -429,7 +429,7 @@ void VisualDeckEditorWidget::setSelectionModel(QItemSelectionModel *model) } if (selectionModel) { - // TODO: Possibly disconnect old ones? + //! \todo Possibly disconnect old signal connections. } selectionModel = model; diff --git a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.h b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.h index 3b90ee4e2..1af565b29 100644 --- a/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_editor_widget.h * @ingroup DeckEditors - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_EDITOR_H #define VISUAL_DECK_EDITOR_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_color_identity_filter_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_color_identity_filter_widget.h index 551dbb35c..0207e2ee2 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_color_identity_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_color_identity_filter_widget.h @@ -1,8 +1,8 @@ /** * @file deck_preview_color_identity_filter_widget.h * @ingroup VisualDeckPreviewWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_COLOR_IDENTITY_FILTER_WIDGET_H #define DECK_PREVIEW_COLOR_IDENTITY_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h index bfd0a170d..4bd7915cd 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h @@ -1,8 +1,8 @@ /** * @file deck_preview_deck_tags_display_widget.h * @ingroup VisualDeckPreviewWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_DECK_TAGS_DISPLAY_WIDGET_H #define DECK_PREVIEW_DECK_TAGS_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_addition_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_addition_widget.h index c0fa86d19..7a3a735a2 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_addition_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_addition_widget.h @@ -1,8 +1,8 @@ /** * @file deck_preview_tag_addition_widget.h * @ingroup VisualDeckPreviewWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_TAG_ADDITION_WIDGET_H #define DECK_PREVIEW_TAG_ADDITION_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_dialog.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_dialog.h index 59b330a65..4d9040af4 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_dialog.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_dialog.h @@ -2,8 +2,8 @@ * @file deck_preview_tag_dialog.h * @ingroup VisualDeckPreviewWidgets * @ingroup Dialogs - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_TAG_DIALOG_H #define DECK_PREVIEW_TAG_DIALOG_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_display_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_display_widget.h index a868aa4f1..980741c5d 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_display_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_display_widget.h @@ -1,8 +1,8 @@ /** * @file deck_preview_tag_display_widget.h * @ingroup VisualDeckPreviewWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_TAG_DISPLAY_WIDGET_H #define DECK_PREVIEW_TAG_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_item_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_item_widget.h index 5caae90a1..a3301799a 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_item_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_tag_item_widget.h @@ -1,8 +1,8 @@ /** * @file deck_preview_tag_item_widget.h * @ingroup VisualDeckPreviewWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_TAG_ITEM_WIDGET_H #define DECK_PREVIEW_TAG_ITEM_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.cpp b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.cpp index 77ea8f865..06dc9dd84 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.cpp +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.cpp @@ -28,8 +28,8 @@ DeckPreviewWidget::DeckPreviewWidget(QWidget *_parent, deckLoader = new DeckLoader(this); connect(deckLoader, &DeckLoader::loadFinished, this, &DeckPreviewWidget::initializeUi); - /* TODO: We shouldn't update the tags on *every* deck load, since it's kinda expensive. We should instead count how - many deck loads have finished already and if we've loaded all decks and THEN load all the tags at once. */ + //! \todo Batch tag refresh: count finished deck loads and refresh tags once all decks are loaded. + // Currently expensive: refreshes on each individual deck load instead of once at the end. connect(deckLoader, &DeckLoader::loadFinished, visualDeckStorageWidget->tagFilterWidget, &VisualDeckStorageTagFilterWidget::refreshTags); deckLoader->loadFromFileAsync(filePath, DeckFileFormat::getFormatFromName(filePath), false); diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.h index 98116cabe..0ed64e9e2 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.h @@ -1,8 +1,8 @@ /** * @file deck_preview_widget.h * @ingroup VisualDeckPreviewWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DECK_PREVIEW_WIDGET_H #define DECK_PREVIEW_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_folder_display_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_folder_display_widget.h index d76fb0497..a5e3be212 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_folder_display_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_folder_display_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_storage_folder_display_widget.h * @ingroup VisualDeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_STORAGE_FOLDER_DISPLAY_WIDGET_H #define VISUAL_DECK_STORAGE_FOLDER_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_search_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_search_widget.h index 67d260b21..2f3d81aeb 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_search_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_search_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_storage_search_widget.h * @ingroup VisualDeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_STORAGE_SEARCH_WIDGET_H #define VISUAL_DECK_STORAGE_SEARCH_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_sort_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_sort_widget.h index 1ea06aba4..24eddba33 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_sort_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_sort_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_storage_sort_widget.h * @ingroup VisualDeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_STORAGE_SORT_WIDGET_H #define VISUAL_DECK_STORAGE_SORT_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_tag_filter_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_tag_filter_widget.h index ada94a244..3290c9e9a 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_tag_filter_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_tag_filter_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_storage_tag_filter_widget.h * @ingroup VisualDeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_STORAGE_TAG_FILTER_WIDGET_H #define VISUAL_DECK_STORAGE_TAG_FILTER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_widget.h index b13c51700..c3c0ae91b 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_widget.h @@ -1,8 +1,8 @@ /** * @file visual_deck_storage_widget.h * @ingroup VisualDeckStorageWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef VISUAL_DECK_STORAGE_WIDGET_H #define VISUAL_DECK_STORAGE_WIDGET_H diff --git a/cockatrice/src/interface/window_main.h b/cockatrice/src/interface/window_main.h index 528e6f211..5f631ddc3 100644 --- a/cockatrice/src/interface/window_main.h +++ b/cockatrice/src/interface/window_main.h @@ -20,8 +20,8 @@ /** * @file window_main.h * @ingroup Core - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef WINDOW_H #define WINDOW_H diff --git a/cockatrice/src/main.h b/cockatrice/src/main.h index b6e086744..ef75a41f4 100644 --- a/cockatrice/src/main.h +++ b/cockatrice/src/main.h @@ -1,8 +1,8 @@ /** * @file main.h * @ingroup Core - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MAIN_H #define MAIN_H diff --git a/libcockatrice_card/libcockatrice/card/card_info_comparator.h b/libcockatrice_card/libcockatrice/card/card_info_comparator.h index b8d9c47e6..b6df8c7a3 100644 --- a/libcockatrice_card/libcockatrice/card/card_info_comparator.h +++ b/libcockatrice_card/libcockatrice/card/card_info_comparator.h @@ -1,8 +1,8 @@ /** * @file card_info_comparator.h * @ingroup Cards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_INFO_COMPARATOR_H #define CARD_INFO_COMPARATOR_H diff --git a/libcockatrice_card/libcockatrice/card/database/card_database.h b/libcockatrice_card/libcockatrice/card/database/card_database.h index b1af3a2c0..521be8fbc 100644 --- a/libcockatrice_card/libcockatrice/card/database/card_database.h +++ b/libcockatrice_card/libcockatrice/card/database/card_database.h @@ -30,27 +30,27 @@ class CardDatabase : public QObject Q_OBJECT protected: - /// Controller to determine set priority when choosing preferred printings. + /** @brief Controller to determine set priority when choosing preferred printings. */ ICardSetPriorityController *setPriorityController; - /// Cards indexed by exact name + /** @brief Cards indexed by exact name. */ CardNameMap cards; - /// Cards indexed by simplified name (normalized) + /** @brief Cards indexed by simplified name (normalized). */ CardNameMap simpleNameCards; - /// Sets indexed by short name + /** @brief Sets indexed by short name. */ SetNameMap sets; FormatRulesNameMap formats; - /// Loader responsible for file discovery and parsing + /** @brief Loader responsible for file discovery and parsing. */ CardDatabaseLoader *loader; - /// Current load status of the database + /** @brief Current load status of the database. */ LoadStatus loadStatus; - /// Querier for higher-level card lookups + /** @brief Querier for higher-level card lookups. */ CardDatabaseQuerier *querier; private: @@ -64,7 +64,7 @@ private: */ void refreshCachedReverseRelatedCards(); - /// Mutexes for thread safety + /** @brief Mutexes for thread safety. */ QBasicMutex *clearDatabaseMutex = new QBasicMutex(), *addCardMutex = new QBasicMutex(), *removeCardMutex = new QBasicMutex(); @@ -133,7 +133,7 @@ public: ICardSetPriorityController *getPriorityController() { return setPriorityController; - }; + } public slots: /** diff --git a/libcockatrice_card/libcockatrice/card/database/card_database_manager.h b/libcockatrice_card/libcockatrice/card/database/card_database_manager.h index 58a744fbb..c7de66a25 100644 --- a/libcockatrice_card/libcockatrice/card/database/card_database_manager.h +++ b/libcockatrice_card/libcockatrice/card/database/card_database_manager.h @@ -67,13 +67,13 @@ private: /** @brief Private destructor. */ ~CardDatabaseManager() = default; - /// Static card preference provider pointer (default: Noop) + /** @brief Static card preference provider pointer (default: Noop). */ static ICardPreferenceProvider *cardPreferenceProvider; - /// Static path provider pointer (default: Noop) + /** @brief Static path provider pointer (default: Noop). */ static ICardDatabasePathProvider *pathProvider; - /// Static set priority controller pointer (default: Noop) + /** @brief Static set priority controller pointer (default: Noop). */ static ICardSetPriorityController *setPriorityController; }; diff --git a/libcockatrice_card/libcockatrice/card/game_specific_terms.h b/libcockatrice_card/libcockatrice/card/game_specific_terms.h index 3616745be..e9160e514 100644 --- a/libcockatrice_card/libcockatrice/card/game_specific_terms.h +++ b/libcockatrice_card/libcockatrice/card/game_specific_terms.h @@ -1,8 +1,8 @@ /** * @file game_specific_terms.h * @ingroup Cards - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef GAME_SPECIFIC_TERMS_H #define GAME_SPECIFIC_TERMS_H diff --git a/libcockatrice_card/libcockatrice/card/set/card_set.h b/libcockatrice_card/libcockatrice/card/set/card_set.h index 2cedb597e..8e16e01df 100644 --- a/libcockatrice_card/libcockatrice/card/set/card_set.h +++ b/libcockatrice_card/libcockatrice/card/set/card_set.h @@ -107,31 +107,31 @@ public: */ [[nodiscard]] QString getCorrectedShortName() const; - /// @return Short identifier of the set. + /** @return Short identifier of the set. */ [[nodiscard]] QString getShortName() const { return shortName; } - /// @return Descriptive name of the set. + /** @return Descriptive name of the set. */ [[nodiscard]] QString getLongName() const { return longName; } - /// @return Type/category string of the set. + /** @return Type/category string of the set. */ [[nodiscard]] QString getSetType() const { return setType; } - /// @return Release date of the set. + /** @return Release date of the set. */ [[nodiscard]] QDate getReleaseDate() const { return releaseDate; } - /// @return Priority level of the set. + /** @return Priority level of the set. */ [[nodiscard]] Priority getPriority() const { return priority; @@ -190,7 +190,7 @@ public: enabled = _enabled; } - /// @return The sort key assigned to this set. + /** @return The sort key assigned to this set. */ [[nodiscard]] int getSortKey() const { return sortKey; @@ -202,7 +202,7 @@ public: */ void setSortKey(unsigned int _sortKey); - /// @return True if the set is enabled. + /** @return True if the set is enabled. */ [[nodiscard]] bool getEnabled() const { return enabled; @@ -214,7 +214,7 @@ public: */ void setEnabled(bool _enabled); - /// @return True if the set is considered known. + /** @return True if the set is considered known. */ [[nodiscard]] bool getIsKnown() const { return isknown; diff --git a/libcockatrice_card/libcockatrice/card/set/card_set_comparator.h b/libcockatrice_card/libcockatrice/card/set/card_set_comparator.h index 96f1052a9..0caa9f156 100644 --- a/libcockatrice_card/libcockatrice/card/set/card_set_comparator.h +++ b/libcockatrice_card/libcockatrice/card/set/card_set_comparator.h @@ -1,8 +1,8 @@ /** * @file card_set_comparator.h * @ingroup CardSets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SET_PRIORITY_COMPARATOR_H #define SET_PRIORITY_COMPARATOR_H diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/deck_list.h b/libcockatrice_deck_list/libcockatrice/deck_list/deck_list.h index a96adeb38..e792c85dc 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/deck_list.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/deck_list.h @@ -89,7 +89,7 @@ private: mutable QString cachedDeckHash; public: - /// @name Metadata setters + /** @name Metadata setters */ ///@{ void setName(const QString &_name = QString()) { @@ -125,11 +125,11 @@ public: } ///@} - /// @brief Construct an empty deck. + /** @brief Construct an empty deck. */ explicit DeckList(); - /// @brief Construct from a serialized native-format string. + /** @brief Construct from a serialized native-format string. */ explicit DeckList(const QString &nativeString); - /// @brief Construct from components + /** @brief Construct from components. */ DeckList(const Metadata &metadata, const DecklistNodeTree &tree, const QMap &sideboardPlans = {}); @@ -144,8 +144,10 @@ public: return &tree; } - /// @name Metadata getters - /// The individual metadata getters still exist for backwards compatibility. + /** + * @name Metadata getters + * The individual metadata getters still exist for backwards compatibility. + */ ///@{ //! \todo Figure out when we can remove them. const Metadata &getMetadata() const @@ -183,7 +185,7 @@ public: return metadata.isEmpty() && getCardList().isEmpty(); } - /// @name Sideboard plans + /** @name Sideboard plans */ ///@{ QList getCurrentSideboardPlan() const; void setCurrentSideboardPlan(const QList &plan); @@ -193,7 +195,7 @@ public: } ///@} - /// @name Serialization (XML) + /** @name Serialization (XML) */ ///@{ bool readElement(QXmlStreamReader *xml); void write(QXmlStreamWriter *xml) const; @@ -204,7 +206,7 @@ public: bool saveToFile_Native(QIODevice *device) const; ///@} - /// @name Serialization (Plain text) + /** @name Serialization (Plain text) */ ///@{ bool loadFromStream_Plain(QTextStream &stream, bool preserveMetadata, @@ -216,7 +218,7 @@ public: QString writeToString_Plain(bool prefixSideboardCards = true, bool slashTappedOutSplitCards = false) const; ///@} - /// @name Deck manipulation + /** @name Deck manipulation */ ///@{ void cleanList(bool preserveMetadata = false); bool isEmpty() const @@ -238,7 +240,7 @@ public: const bool formatLegal = true); ///@} - /// @name Deck identity + /** @name Deck identity */ ///@{ QString getDeckHash() const; void refreshDeckHash(); diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/deck_list_node_tree.h b/libcockatrice_deck_list/libcockatrice/deck_list/deck_list_node_tree.h index 6de760634..8ef0b18a5 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/deck_list_node_tree.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/deck_list_node_tree.h @@ -12,11 +12,11 @@ class DecklistNodeTree InnerDecklistNode *root; ///< Root of the deck tree (zones + cards). public: - /// @brief Constructs an empty DecklistNodeTree + /** @brief Constructs an empty DecklistNodeTree. */ explicit DecklistNodeTree(); - /// @brief Copy constructor. Deep copies the tree + /** @brief Copy constructor. Deep copies the tree. */ explicit DecklistNodeTree(const DecklistNodeTree &other); - /// @brief Copy-assignment operator. Deep copies the tree + /** @brief Copy-assignment operator. Deep copies the tree. */ DecklistNodeTree &operator=(const DecklistNodeTree &other); virtual ~DecklistNodeTree(); diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/sideboard_plan.h b/libcockatrice_deck_list/libcockatrice/deck_list/sideboard_plan.h index 524217c2d..fff4ff2f3 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/sideboard_plan.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/sideboard_plan.h @@ -51,19 +51,19 @@ public: */ void write(QXmlStreamWriter *xml) const; - /// @return The plan name. + /** @return The plan name. */ [[nodiscard]] QString getName() const { return name; } - /// @return Const reference to the move list. + /** @return Const reference to the move list. */ [[nodiscard]] const QList &getMoveList() const { return moveList; } - /// @brief Replace the move list with a new one. + /** @brief Replace the move list with a new one. */ void setMoveList(const QList &_moveList); }; diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_card_node.h b/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_card_node.h index 88d8b0930..df903a168 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_card_node.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_card_node.h @@ -58,40 +58,40 @@ public: { } - /// @return The number of copies of this card in the deck. + /** @return The number of copies of this card in the deck. */ [[nodiscard]] virtual int getNumber() const = 0; - /// @param _number Set the number of copies of this card. + /** @param _number Set the number of copies of this card. */ virtual void setNumber(int _number) = 0; - /// @return The display name of this card. + /** @return The display name of this card. */ [[nodiscard]] QString getName() const override = 0; - /// @param _name Set the display name of this card. + /** @param _name Set the display name of this card. */ virtual void setName(const QString &_name) = 0; - /// @return The provider identifier for this card (e.g., UUID). + /** @return The provider identifier for this card (e.g., UUID). */ [[nodiscard]] virtual QString getCardProviderId() const override = 0; - /// @param _cardProviderId Set the provider identifier for this card. + /** @param _cardProviderId Set the provider identifier for this card. */ virtual void setCardProviderId(const QString &_cardProviderId) = 0; - /// @return The abbreviated set code (e.g., "NEO"). + /** @return The abbreviated set code (e.g., "NEO"). */ [[nodiscard]] virtual QString getCardSetShortName() const override = 0; - /// @param _cardSetShortName Set the abbreviated set code. + /** @param _cardSetShortName Set the abbreviated set code. */ virtual void setCardSetShortName(const QString &_cardSetShortName) = 0; - /// @return The collector number of the card within its set. + /** @return The collector number of the card within its set. */ [[nodiscard]] virtual QString getCardCollectorNumber() const override = 0; - /// @param _cardSetNumber Set the collector number. + /** @param _cardSetNumber Set the collector number. */ virtual void setCardCollectorNumber(const QString &_cardSetNumber) = 0; - /// @return The format legality of the card + /** @return The format legality of the card. */ virtual bool getFormatLegality() const = 0; - /// @param _formatLegal If the card is considered legal + /** @param _formatLegal If the card is considered legal. */ virtual void setFormatLegality(const bool _formatLegal) = 0; /** diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_node.h b/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_node.h index 877705705..a39f0e7b2 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_node.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/tree/abstract_deck_list_node.h @@ -101,7 +101,7 @@ public: */ explicit AbstractDecklistNode(InnerDecklistNode *_parent = nullptr, int position = -1); - /// Virtual destructor. Child classes must clean up their resources. + /** @brief Virtual destructor. Child classes must clean up their resources. */ virtual ~AbstractDecklistNode() = default; /** @@ -136,7 +136,7 @@ public: */ [[nodiscard]] virtual bool isDeckHeader() const = 0; - /// @return The parent node, or nullptr if this is the root. + /** @return The parent node, or nullptr if this is the root. */ [[nodiscard]] InnerDecklistNode *getParent() const { return parent; diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/tree/deck_list_card_node.h b/libcockatrice_deck_list/libcockatrice/deck_list/tree/deck_list_card_node.h index b3d42b89a..3bab5405a 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/tree/deck_list_card_node.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/tree/deck_list_card_node.h @@ -93,79 +93,79 @@ public: */ explicit DecklistCardNode(DecklistCardNode *other, InnerDecklistNode *_parent); - /// @return The quantity of this card. + /** @return The quantity of this card. */ [[nodiscard]] int getNumber() const override { return number; } - /// @param _number Set the quantity of this card. + /** @param _number Set the quantity of this card. */ void setNumber(int _number) override { number = _number; } - /// @return The display name of this card. + /** @return The display name of this card. */ [[nodiscard]] QString getName() const override { return name; } - /// @param _name Set the display name of this card. + /** @param _name Set the display name of this card. */ void setName(const QString &_name) override { name = _name; } - /// @return The provider identifier for this card. + /** @return The provider identifier for this card. */ [[nodiscard]] QString getCardProviderId() const override { return cardProviderId; } - /// @param _providerId Set the provider identifier for this card. + /** @param _providerId Set the provider identifier for this card. */ void setCardProviderId(const QString &_providerId) override { cardProviderId = _providerId; } - /// @return The short set code (e.g., "NEO"). + /** @return The short set code (e.g., "NEO"). */ [[nodiscard]] QString getCardSetShortName() const override { return cardSetShortName; } - /// @param _cardSetShortName Set the short set code. + /** @param _cardSetShortName Set the short set code. */ void setCardSetShortName(const QString &_cardSetShortName) override { cardSetShortName = _cardSetShortName; } - /// @return The collector number of this card within its set. + /** @return The collector number of this card within its set. */ [[nodiscard]] QString getCardCollectorNumber() const override { return cardSetNumber; } - /// @param _cardSetNumber Set the collector number. + /** @param _cardSetNumber Set the collector number. */ void setCardCollectorNumber(const QString &_cardSetNumber) override { cardSetNumber = _cardSetNumber; } - /// @return The format legality of the card + /** @return The format legality of the card. */ [[nodiscard]] bool getFormatLegality() const override { return formatLegal; } - /// @param _formatLegal If the card is considered legal + /** @param _formatLegal If the card is considered legal. */ void setFormatLegality(const bool _formatLegal) override { formatLegal = _formatLegal; } - /// @return Always false; card nodes are not deck headers. + /** @return Always false; card nodes are not deck headers. */ [[nodiscard]] bool isDeckHeader() const override { return false; diff --git a/libcockatrice_deck_list/libcockatrice/deck_list/tree/inner_deck_list_node.h b/libcockatrice_deck_list/libcockatrice/deck_list/tree/inner_deck_list_node.h index f4c48afce..81c37dffa 100644 --- a/libcockatrice_deck_list/libcockatrice/deck_list/tree/inner_deck_list_node.h +++ b/libcockatrice_deck_list/libcockatrice/deck_list/tree/inner_deck_list_node.h @@ -18,11 +18,11 @@ #include "abstract_deck_list_node.h" -/// Constant for the "main" deck zone name. +/** @brief Constant for the "main" deck zone name. */ #define DECK_ZONE_MAIN "main" -/// Constant for the "sideboard" zone name. +/** @brief Constant for the "sideboard" zone name. */ #define DECK_ZONE_SIDE "side" -/// Constant for the "tokens" zone name. +/** @brief Constant for the "tokens" zone name. */ #define DECK_ZONE_TOKENS "tokens" /** @@ -93,13 +93,13 @@ public: */ void setSortMethod(DeckSortMethod method) override; - /// @return The internal name of this node. + /** @return The internal name of this node. */ [[nodiscard]] QString getName() const override { return name; } - /// @param _name Set the internal name of this node. + /** @param _name Set the internal name of this node. */ void setName(const QString &_name) { name = _name; @@ -122,25 +122,25 @@ public: */ [[nodiscard]] virtual QString getVisibleName() const; - /// @return Always empty for container nodes. + /** @return Always empty for container nodes. */ [[nodiscard]] QString getCardProviderId() const override { return ""; } - /// @return Always empty for container nodes. + /** @return Always empty for container nodes. */ [[nodiscard]] QString getCardSetShortName() const override { return ""; } - /// @return Always empty for container nodes. + /** @return Always empty for container nodes. */ [[nodiscard]] QString getCardCollectorNumber() const override { return ""; } - /// @return Always true; InnerDecklistNode represents deck structure. + /** @return Always true; InnerDecklistNode represents deck structure. */ [[nodiscard]] bool isDeckHeader() const override { return true; @@ -196,10 +196,10 @@ public: */ bool compare(AbstractDecklistNode *other) const override; - /// @copydoc compare(AbstractDecklistNode*) const + /** @copydoc compare(AbstractDecklistNode*) const */ bool compareNumber(AbstractDecklistNode *other) const; - /// @copydoc compare(AbstractDecklistNode*) const + /** @copydoc compare(AbstractDecklistNode*) const */ bool compareName(AbstractDecklistNode *other) const; /** diff --git a/libcockatrice_filters/libcockatrice/filters/filter_card.h b/libcockatrice_filters/libcockatrice/filters/filter_card.h index 732e43a09..bb1e0ef53 100644 --- a/libcockatrice_filters/libcockatrice/filters/filter_card.h +++ b/libcockatrice_filters/libcockatrice/filters/filter_card.h @@ -1,8 +1,8 @@ /** * @file filter_card.h * @ingroup CardDatabaseModelFilters - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDFILTER_H #define CARDFILTER_H diff --git a/libcockatrice_filters/libcockatrice/filters/filter_string.h b/libcockatrice_filters/libcockatrice/filters/filter_string.h index 8fc41ce68..71a99f7b5 100644 --- a/libcockatrice_filters/libcockatrice/filters/filter_string.h +++ b/libcockatrice_filters/libcockatrice/filters/filter_string.h @@ -1,8 +1,8 @@ /** * @file filter_string.h * @ingroup CardDatabaseModelFilters - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef FILTER_STRING_H #define FILTER_STRING_H diff --git a/libcockatrice_filters/libcockatrice/filters/filter_tree.h b/libcockatrice_filters/libcockatrice/filters/filter_tree.h index 75d4241a5..aac1777e0 100644 --- a/libcockatrice_filters/libcockatrice/filters/filter_tree.h +++ b/libcockatrice_filters/libcockatrice/filters/filter_tree.h @@ -1,8 +1,8 @@ /** * @file filter_tree.h * @ingroup CardDatabaseModelFilters - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef FILTERTREE_H #define FILTERTREE_H @@ -70,28 +70,33 @@ public: } virtual void nodeChanged() const { - if (parent() != nullptr) + if (parent() != nullptr) { parent()->nodeChanged(); + } } virtual void preInsertChild(const FilterTreeNode *p, int i) const { - if (parent() != nullptr) + if (parent() != nullptr) { parent()->preInsertChild(p, i); + } } virtual void postInsertChild(const FilterTreeNode *p, int i) const { - if (parent() != nullptr) + if (parent() != nullptr) { parent()->postInsertChild(p, i); + } } virtual void preRemoveChild(const FilterTreeNode *p, int i) const { - if (parent() != nullptr) + if (parent() != nullptr) { parent()->preRemoveChild(p, i); + } } virtual void postRemoveChild(const FilterTreeNode *p, int i) const { - if (parent() != nullptr) + if (parent() != nullptr) { parent()->postRemoveChild(p, i); + } } }; diff --git a/libcockatrice_models/libcockatrice/models/database/card/card_completer_proxy_model.h b/libcockatrice_models/libcockatrice/models/database/card/card_completer_proxy_model.h index afb6f1fcf..91dc06335 100644 --- a/libcockatrice_models/libcockatrice/models/database/card/card_completer_proxy_model.h +++ b/libcockatrice_models/libcockatrice/models/database/card/card_completer_proxy_model.h @@ -1,8 +1,8 @@ /** * @file card_completer_proxy_model.h * @ingroup CardDatabaseModels - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_COMPLETER_PROXY_MODEL_H #define CARD_COMPLETER_PROXY_MODEL_H diff --git a/libcockatrice_models/libcockatrice/models/database/card/card_search_model.h b/libcockatrice_models/libcockatrice/models/database/card/card_search_model.h index 18be2c55a..bc4be7a0e 100644 --- a/libcockatrice_models/libcockatrice/models/database/card/card_search_model.h +++ b/libcockatrice_models/libcockatrice/models/database/card/card_search_model.h @@ -1,8 +1,8 @@ /** * @file card_search_model.h * @ingroup CardDatabaseModels - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARD_SEARCH_MODEL_H #define CARD_SEARCH_MODEL_H diff --git a/libcockatrice_models/libcockatrice/models/database/card_set/card_sets_model.h b/libcockatrice_models/libcockatrice/models/database/card_set/card_sets_model.h index 0ffc5a847..2adf71def 100644 --- a/libcockatrice_models/libcockatrice/models/database/card_set/card_sets_model.h +++ b/libcockatrice_models/libcockatrice/models/database/card_set/card_sets_model.h @@ -1,8 +1,8 @@ /** * @file sets_model.h * @ingroup CardDatabaseModels - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SETSMODEL_H #define SETSMODEL_H diff --git a/libcockatrice_models/libcockatrice/models/database/token/token_display_model.h b/libcockatrice_models/libcockatrice/models/database/token/token_display_model.h index f6b2fdfbb..c8f767189 100644 --- a/libcockatrice_models/libcockatrice/models/database/token/token_display_model.h +++ b/libcockatrice_models/libcockatrice/models/database/token/token_display_model.h @@ -1,8 +1,8 @@ /** * @file token_display_model.h * @ingroup CardDatabaseModels - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_TOKEN_DISPLAY_MODEL_H #define COCKATRICE_TOKEN_DISPLAY_MODEL_H diff --git a/libcockatrice_models/libcockatrice/models/database/token/token_edit_model.h b/libcockatrice_models/libcockatrice/models/database/token/token_edit_model.h index 5e5843761..92dfaadd7 100644 --- a/libcockatrice_models/libcockatrice/models/database/token/token_edit_model.h +++ b/libcockatrice_models/libcockatrice/models/database/token/token_edit_model.h @@ -1,8 +1,8 @@ /** * @file token_edit_model.h * @ingroup CardDatabaseModels - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_TOKEN_EDIT_MODEL_H #define COCKATRICE_TOKEN_EDIT_MODEL_H diff --git a/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.cpp b/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.cpp index e43c612f0..9b43281c1 100644 --- a/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.cpp +++ b/libcockatrice_models/libcockatrice/models/deck_list/deck_list_model.cpp @@ -66,7 +66,7 @@ void DeckListModel::rebuildTree() for (int j = 0; j < currentZone->size(); j++) { auto *currentCard = dynamic_cast(currentZone->at(j)); - // TODO: better sanity checking + //! \todo Better sanity checking. if (currentCard == nullptr) { continue; } @@ -257,8 +257,9 @@ Qt::ItemFlags DeckListModel::flags(const QModelIndex &index) const void DeckListModel::emitBackgroundUpdates(const QModelIndex &parent) { int rows = rowCount(parent); - if (rows == 0) + if (rows == 0) { return; + } QModelIndex topLeft = index(0, 0, parent); QModelIndex bottomRight = index(rows - 1, columnCount() - 1, parent); @@ -539,8 +540,9 @@ int DeckListModel::findSortedInsertRow(const InnerDecklistNode *parent, const Ca for (int i = 0; i < parent->size(); ++i) { auto *existingCard = dynamic_cast(parent->at(i)); - if (!existingCard) + if (!existingCard) { continue; + } bool lessThan = false; switch (lastKnownColumn) { @@ -557,8 +559,9 @@ int DeckListModel::findSortedInsertRow(const InnerDecklistNode *parent, const Ca break; } - if (lessThan) + if (lessThan) { return i; + } } return parent->size(); // insert at end if no earlier match diff --git a/libcockatrice_models/libcockatrice/models/deck_list/deck_list_sort_filter_proxy_model.h b/libcockatrice_models/libcockatrice/models/deck_list/deck_list_sort_filter_proxy_model.h index 94742795d..1565417f0 100644 --- a/libcockatrice_models/libcockatrice/models/deck_list/deck_list_sort_filter_proxy_model.h +++ b/libcockatrice_models/libcockatrice/models/deck_list/deck_list_sort_filter_proxy_model.h @@ -1,8 +1,8 @@ /** * @file deck_list_sort_filter_proxy_model.h * @ingroup DeckEditorCardGroupWidgets - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_DECK_LIST_SORT_FILTER_PROXY_MODEL_H #define COCKATRICE_DECK_LIST_SORT_FILTER_PROXY_MODEL_H diff --git a/libcockatrice_network/libcockatrice/network/client/abstract/abstract_client.h b/libcockatrice_network/libcockatrice/network/client/abstract/abstract_client.h index dc3be5a94..2eb7e3356 100644 --- a/libcockatrice_network/libcockatrice/network/client/abstract/abstract_client.h +++ b/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 diff --git a/libcockatrice_network/libcockatrice/network/client/local/local_client.h b/libcockatrice_network/libcockatrice/network/client/local/local_client.h index e8c5330ac..9e1c89ddd 100644 --- a/libcockatrice_network/libcockatrice/network/client/local/local_client.h +++ b/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 diff --git a/libcockatrice_network/libcockatrice/network/client/remote/remote_client.cpp b/libcockatrice_network/libcockatrice/network/client/remote/remote_client.cpp index 0ef211b94..7e20f2722 100644 --- a/libcockatrice_network/libcockatrice/network/client/remote/remote_client.cpp +++ b/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()) { diff --git a/libcockatrice_network/libcockatrice/network/client/remote/remote_client.h b/libcockatrice_network/libcockatrice/network/client/remote/remote_client.h index 15e3e8ef5..289fdc5d0 100644 --- a/libcockatrice_network/libcockatrice/network/client/remote/remote_client.h +++ b/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 diff --git a/libcockatrice_network/libcockatrice/network/server/local/local_server.h b/libcockatrice_network/libcockatrice/network/server/local/local_server.h index 70586f6c1..0112afa72 100644 --- a/libcockatrice_network/libcockatrice/network/server/local/local_server.h +++ b/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 diff --git a/libcockatrice_network/libcockatrice/network/server/local/local_server_interface.h b/libcockatrice_network/libcockatrice/network/server/local/local_server_interface.h index 4410fd65c..44e3b3e53 100644 --- a/libcockatrice_network/libcockatrice/network/server/local/local_server_interface.h +++ b/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 diff --git a/libcockatrice_network/libcockatrice/network/server/remote/game/server_game.cpp b/libcockatrice_network/libcockatrice/network/server/remote/game/server_game.cpp index f5a4889d0..50fff4812 100644 --- a/libcockatrice_network/libcockatrice/network/server/remote/game/server_game.cpp +++ b/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)); diff --git a/libcockatrice_network/libcockatrice/network/server/remote/server.cpp b/libcockatrice_network/libcockatrice/network/server/remote/server.cpp index 904637797..3da9ddc73 100644 --- a/libcockatrice_network/libcockatrice/network/server/remote/server.cpp +++ b/libcockatrice_network/libcockatrice/network/server/remote/server.cpp @@ -286,7 +286,7 @@ QList 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(); diff --git a/libcockatrice_protocol/libcockatrice/protocol/pending_command.h b/libcockatrice_protocol/libcockatrice/protocol/pending_command.h index 1d2d9ff17..dbe57e7fc 100644 --- a/libcockatrice_protocol/libcockatrice/protocol/pending_command.h +++ b/libcockatrice_protocol/libcockatrice/protocol/pending_command.h @@ -1,8 +1,8 @@ /** * @file pending_command.h * @ingroup Messages - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef PENDING_COMMAND_H #define PENDING_COMMAND_H diff --git a/libcockatrice_settings/libcockatrice/settings/card_database_settings.h b/libcockatrice_settings/libcockatrice/settings/card_database_settings.h index 5dea1b552..97efb5753 100644 --- a/libcockatrice_settings/libcockatrice/settings/card_database_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/card_database_settings.h @@ -2,8 +2,8 @@ * @file card_database_settings.h * @ingroup CardDatabase * @ingroup CardSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef CARDDATABASESETTINGS_H #define CARDDATABASESETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/card_override_settings.h b/libcockatrice_settings/libcockatrice/settings/card_override_settings.h index 3d9db4e65..cd515d4da 100644 --- a/libcockatrice_settings/libcockatrice/settings/card_override_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/card_override_settings.h @@ -1,8 +1,8 @@ /** * @file card_override_settings.h * @ingroup CardSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_CARD_OVERRIDE_SETTINGS_H #define COCKATRICE_CARD_OVERRIDE_SETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/debug_settings.h b/libcockatrice_settings/libcockatrice/settings/debug_settings.h index 30cdd5fa5..acb5cf313 100644 --- a/libcockatrice_settings/libcockatrice/settings/debug_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/debug_settings.h @@ -1,8 +1,8 @@ /** * @file debug_settings.h * @ingroup CoreSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef DEBUG_SETTINGS_H #define DEBUG_SETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/download_settings.h b/libcockatrice_settings/libcockatrice/settings/download_settings.h index b7442301e..60e59220b 100644 --- a/libcockatrice_settings/libcockatrice/settings/download_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/download_settings.h @@ -1,8 +1,8 @@ /** * @file download_settings.h * @ingroup NetworkSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef COCKATRICE_DOWNLOADSETTINGS_H #define COCKATRICE_DOWNLOADSETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/game_filters_settings.h b/libcockatrice_settings/libcockatrice/settings/game_filters_settings.h index c0e60551a..24f582007 100644 --- a/libcockatrice_settings/libcockatrice/settings/game_filters_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/game_filters_settings.h @@ -2,8 +2,8 @@ * @file game_filters_settings.h * @ingroup Lobby * @ingroup GameSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef GAMEFILTERSSETTINGS_H #define GAMEFILTERSSETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/layouts_settings.h b/libcockatrice_settings/libcockatrice/settings/layouts_settings.h index 5353ce15a..d5f26b61b 100644 --- a/libcockatrice_settings/libcockatrice/settings/layouts_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/layouts_settings.h @@ -1,8 +1,8 @@ /** * @file layouts_settings.h * @ingroup CoreSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef LAYOUTSSETTINGS_H #define LAYOUTSSETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/message_settings.h b/libcockatrice_settings/libcockatrice/settings/message_settings.h index ec70027af..8276aa39d 100644 --- a/libcockatrice_settings/libcockatrice/settings/message_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/message_settings.h @@ -1,8 +1,8 @@ /** * @file message_settings.h * @ingroup NetworkSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef MESSAGESETTINGS_H #define MESSAGESETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/recents_settings.h b/libcockatrice_settings/libcockatrice/settings/recents_settings.h index 3aebff334..01b2a37bc 100644 --- a/libcockatrice_settings/libcockatrice/settings/recents_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/recents_settings.h @@ -1,8 +1,8 @@ /** * @file recents_settings.h * @ingroup DeckSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef RECENTS_SETTINGS_H #define RECENTS_SETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/servers_settings.h b/libcockatrice_settings/libcockatrice/settings/servers_settings.h index 22603a356..40fa996fb 100644 --- a/libcockatrice_settings/libcockatrice/settings/servers_settings.h +++ b/libcockatrice_settings/libcockatrice/settings/servers_settings.h @@ -1,8 +1,8 @@ /** * @file servers_settings.h * @ingroup NetworkSettings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SERVERSSETTINGS_H #define SERVERSSETTINGS_H diff --git a/libcockatrice_settings/libcockatrice/settings/settings_manager.h b/libcockatrice_settings/libcockatrice/settings/settings_manager.h index a02bafcac..4213cf4c1 100644 --- a/libcockatrice_settings/libcockatrice/settings/settings_manager.h +++ b/libcockatrice_settings/libcockatrice/settings/settings_manager.h @@ -1,8 +1,8 @@ /** * @file settings_manager.h * @ingroup Settings - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef SETTINGSMANAGER_H #define SETTINGSMANAGER_H diff --git a/libcockatrice_utility/libcockatrice/utility/levenshtein.h b/libcockatrice_utility/libcockatrice/utility/levenshtein.h index e83235470..3da730e53 100644 --- a/libcockatrice_utility/libcockatrice/utility/levenshtein.h +++ b/libcockatrice_utility/libcockatrice/utility/levenshtein.h @@ -1,8 +1,8 @@ /** * @file levenshtein.h * @ingroup Core - * @brief TODO: Document this. */ +//! \todo Document this file. #ifndef LEVENSHTEIN_H #define LEVENSHTEIN_H diff --git a/servatrice/src/serversocketinterface.cpp b/servatrice/src/serversocketinterface.cpp index 5549074c5..bc90a3ef1 100644 --- a/servatrice/src/serversocketinterface.cpp +++ b/servatrice/src/serversocketinterface.cpp @@ -1286,7 +1286,7 @@ Response::ResponseCode AbstractServerSocketInterface::cmdRegisterAccount(const C return Response::RespEmailBlackListed; } - //! \todo Move this method outside of the db interface + //! \todo Move this method outside of the db interface. QString errorString; if (!sqlInterface->usernameIsValid(userName, errorString)) { if (servatrice->getEnableRegistrationAudit()) { @@ -1421,7 +1421,7 @@ Response::ResponseCode AbstractServerSocketInterface::cmdRegisterAccount(const C bool AbstractServerSocketInterface::tooManyRegistrationAttempts(const QString &ipAddress) { - //! \todo implement + //! \todo Implement registration attempt limiting. Q_UNUSED(ipAddress); return false; }