From fca212760e3f171394267e7812018801c51b89c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20Br=C3=BCbach?= Date: Wed, 1 Oct 2025 22:58:55 +0200 Subject: [PATCH] Regroup a whole bunch of files. Took 1 hour 38 minutes --- .../parsers/deck_link_to_api_transformer.h | 2 +- .../parsers/interface_json_deck_parser.h | 2 +- .../network/spoiler_background_updater.h | 2 +- cockatrice/src/client/tapped_out_interface.h | 4 +- cockatrice/src/deck/deck_stats_interface.h | 4 +- cockatrice/src/dialogs/dlg_connect.h | 2 +- .../dialogs/dlg_convert_deck_to_cod_format.h | 5 +- cockatrice/src/dialogs/dlg_create_game.h | 3 +- cockatrice/src/dialogs/dlg_edit_avatar.h | 2 +- cockatrice/src/dialogs/dlg_edit_password.h | 2 +- cockatrice/src/dialogs/dlg_filter_games.h | 3 +- .../dialogs/dlg_forgot_password_challenge.h | 2 +- .../src/dialogs/dlg_forgot_password_request.h | 2 +- .../src/dialogs/dlg_forgot_password_reset.h | 2 +- cockatrice/src/dialogs/dlg_load_deck.h | 3 +- .../dialogs/dlg_load_deck_from_clipboard.h | 3 +- .../src/dialogs/dlg_load_deck_from_website.h | 3 +- cockatrice/src/dialogs/dlg_load_remote_deck.h | 3 +- cockatrice/src/dialogs/dlg_register.h | 2 +- .../src/dialogs/dlg_startup_card_check.h | 2 +- cockatrice/src/dialogs/dlg_update.h | 2 +- cockatrice/src/dialogs/dlg_view_log.h | 2 +- cockatrice/src/interface/theme_manager.h | 3 +- cockatrice/src/server/chat_view/chat_view.h | 3 +- cockatrice/src/server/games_model.h | 1 - cockatrice/src/server/handle_public_servers.h | 2 +- cockatrice/src/server/pending_command.h | 2 +- .../remote/remote_decklist_tree_widget.h | 2 +- .../remote/remote_replay_list_tree_widget.h | 2 +- cockatrice/src/server/user/user_info_box.h | 1 - .../src/server/user/user_info_connection.h | 2 +- .../src/server/user/user_list_manager.h | 1 - cockatrice/src/server/user/user_list_widget.h | 1 - cockatrice/src/settings/cache_settings.h | 1 - .../src/settings/card_counter_settings.h | 2 +- .../src/settings/card_database_settings.h | 2 +- .../src/settings/card_override_settings.h | 2 +- cockatrice/src/settings/debug_settings.h | 3 +- cockatrice/src/settings/download_settings.h | 3 +- .../src/settings/game_filters_settings.h | 2 +- cockatrice/src/settings/layouts_settings.h | 2 +- cockatrice/src/settings/message_settings.h | 3 +- cockatrice/src/settings/recents_settings.h | 3 +- cockatrice/src/settings/servers_settings.h | 3 +- cockatrice/src/settings/shortcut_treeview.h | 2 +- cockatrice/src/settings/shortcuts_settings.h | 2 +- cockatrice/src/tabs/tab_account.h | 2 +- cockatrice/src/tabs/tab_admin.h | 2 +- cockatrice/src/tabs/tab_logs.h | 2 +- cockatrice/src/tabs/tab_message.h | 2 +- cockatrice/src/tabs/tab_room.h | 2 +- cockatrice/src/tabs/tab_server.h | 2 +- doc/doxygen-groups/doc_groups.dox | 190 ++++++++++++++++-- 53 files changed, 221 insertions(+), 88 deletions(-) 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 190fd5488..1e2372fd1 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,6 +1,6 @@ /** * @file deck_link_to_api_transformer.h - * @ingroup Network + * @ingroup ApiInterfaces * @brief TODO: Document this. */ 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 ace7e1623..e58f31bcc 100644 --- a/cockatrice/src/client/network/parsers/interface_json_deck_parser.h +++ b/cockatrice/src/client/network/parsers/interface_json_deck_parser.h @@ -1,6 +1,6 @@ /** * @file interface_json_deck_parser.h - * @ingroup Network + * @ingroup ApiInterfaces * @brief TODO: Document this. */ diff --git a/cockatrice/src/client/network/spoiler_background_updater.h b/cockatrice/src/client/network/spoiler_background_updater.h index e3d254528..387f93820 100644 --- a/cockatrice/src/client/network/spoiler_background_updater.h +++ b/cockatrice/src/client/network/spoiler_background_updater.h @@ -1,6 +1,6 @@ /** * @file spoiler_background_updater.h - * @ingroup Network + * @ingroup Client * @brief TODO: Document this. */ diff --git a/cockatrice/src/client/tapped_out_interface.h b/cockatrice/src/client/tapped_out_interface.h index 096015bed..43e5cdea3 100644 --- a/cockatrice/src/client/tapped_out_interface.h +++ b/cockatrice/src/client/tapped_out_interface.h @@ -1,8 +1,6 @@ /** * @file tapped_out_interface.h - * @ingroup ImportExport - * @ingroup Parsing - * @ingroup Network + * @ingroup ApiInterfaces * @brief TODO: Document this. */ diff --git a/cockatrice/src/deck/deck_stats_interface.h b/cockatrice/src/deck/deck_stats_interface.h index ccb530b5a..8a76b35fc 100644 --- a/cockatrice/src/deck/deck_stats_interface.h +++ b/cockatrice/src/deck/deck_stats_interface.h @@ -1,8 +1,6 @@ /** * @file deck_stats_interface.h - * @ingroup ImportExport - * @ingroup Parsing - * @ingroup Network + * @ingroup ApiInterfaces * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_connect.h b/cockatrice/src/dialogs/dlg_connect.h index 89d7a6943..b2afbef4d 100644 --- a/cockatrice/src/dialogs/dlg_connect.h +++ b/cockatrice/src/dialogs/dlg_connect.h @@ -1,6 +1,6 @@ /** * @file dlg_connect.h - * @ingroup NetworkDialogs + * @ingroup ConnectionDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h b/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h index e608c247e..7c5ea303a 100644 --- a/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h +++ b/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h @@ -1,8 +1,7 @@ /** * @file dlg_convert_deck_to_cod_format.h - * @ingroup Dialogs - * @ingroup DeckStorageWidgets - * @ingroup ImportExport + * @ingroup LocalDeckStorageDialogs + * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_create_game.h b/cockatrice/src/dialogs/dlg_create_game.h index 24b972fe0..ac7592b94 100644 --- a/cockatrice/src/dialogs/dlg_create_game.h +++ b/cockatrice/src/dialogs/dlg_create_game.h @@ -1,7 +1,6 @@ /** * @file dlg_create_game.h - * @ingroup NetworkDialogs - * @ingroup Lobby + * @ingroup RoomDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_edit_avatar.h b/cockatrice/src/dialogs/dlg_edit_avatar.h index c96d56571..641b736dc 100644 --- a/cockatrice/src/dialogs/dlg_edit_avatar.h +++ b/cockatrice/src/dialogs/dlg_edit_avatar.h @@ -1,6 +1,6 @@ /** * @file dlg_edit_avatar.h - * @ingroup NetworkDialogs + * @ingroup AccountDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_edit_password.h b/cockatrice/src/dialogs/dlg_edit_password.h index 8f7b2b9aa..38f782228 100644 --- a/cockatrice/src/dialogs/dlg_edit_password.h +++ b/cockatrice/src/dialogs/dlg_edit_password.h @@ -1,6 +1,6 @@ /** * @file dlg_edit_password.h - * @ingroup NetworkDialogs + * @ingroup AccountDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_filter_games.h b/cockatrice/src/dialogs/dlg_filter_games.h index 1205a89f2..bba68b973 100644 --- a/cockatrice/src/dialogs/dlg_filter_games.h +++ b/cockatrice/src/dialogs/dlg_filter_games.h @@ -1,7 +1,6 @@ /** * @file dlg_filter_games.h - * @ingroup Lobby - * @ingroup NetworkDialogs + * @ingroup RoomDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_forgot_password_challenge.h b/cockatrice/src/dialogs/dlg_forgot_password_challenge.h index fdb9514c0..88427a7c9 100644 --- a/cockatrice/src/dialogs/dlg_forgot_password_challenge.h +++ b/cockatrice/src/dialogs/dlg_forgot_password_challenge.h @@ -1,6 +1,6 @@ /** * @file dlg_forgot_password_challenge.h - * @ingroup NetworkDialogs + * @ingroup AccountDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_forgot_password_request.h b/cockatrice/src/dialogs/dlg_forgot_password_request.h index a45f6f200..da4d9e726 100644 --- a/cockatrice/src/dialogs/dlg_forgot_password_request.h +++ b/cockatrice/src/dialogs/dlg_forgot_password_request.h @@ -1,6 +1,6 @@ /** * @file dlg_forgot_password_request.h - * @ingroup NetworkDialogs + * @ingroup AccountDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_forgot_password_reset.h b/cockatrice/src/dialogs/dlg_forgot_password_reset.h index 40d29cf94..ede22e2aa 100644 --- a/cockatrice/src/dialogs/dlg_forgot_password_reset.h +++ b/cockatrice/src/dialogs/dlg_forgot_password_reset.h @@ -1,6 +1,6 @@ /** * @file dlg_forgot_password_reset.h - * @ingroup NetworkDialogs + * @ingroup AccountDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_load_deck.h b/cockatrice/src/dialogs/dlg_load_deck.h index 9d2ad2924..b103f6a56 100644 --- a/cockatrice/src/dialogs/dlg_load_deck.h +++ b/cockatrice/src/dialogs/dlg_load_deck.h @@ -1,7 +1,6 @@ /** * @file dlg_load_deck.h - * @ingroup Dialogs - * @ingroup ImportExport + * @ingroup LocalDeckStorageDialogs * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h b/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h index 755cf9f77..7873d4bf3 100644 --- a/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h +++ b/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h @@ -1,7 +1,6 @@ /** * @file dlg_load_deck_from_clipboard.h - * @ingroup Dialogs - * @ingroup ImportExport + * @ingroup LocalDeckStorageDialogs * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_load_deck_from_website.h b/cockatrice/src/dialogs/dlg_load_deck_from_website.h index 6e51eb736..84adb760f 100644 --- a/cockatrice/src/dialogs/dlg_load_deck_from_website.h +++ b/cockatrice/src/dialogs/dlg_load_deck_from_website.h @@ -1,7 +1,6 @@ /** * @file dlg_load_deck_from_website.h - * @ingroup Dialogs - * @ingroup ImportExport + * @ingroup RemoteDeckStorageDialogs * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_load_remote_deck.h b/cockatrice/src/dialogs/dlg_load_remote_deck.h index f997bbb77..372db5ba8 100644 --- a/cockatrice/src/dialogs/dlg_load_remote_deck.h +++ b/cockatrice/src/dialogs/dlg_load_remote_deck.h @@ -1,7 +1,6 @@ /** * @file dlg_load_remote_deck.h - * @ingroup Dialogs - * @ingroup ImportExport + * @ingroup RemoteDeckStorageDialogs * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_register.h b/cockatrice/src/dialogs/dlg_register.h index 89bb7930f..a614386fc 100644 --- a/cockatrice/src/dialogs/dlg_register.h +++ b/cockatrice/src/dialogs/dlg_register.h @@ -1,6 +1,6 @@ /** * @file dlg_register.h - * @ingroup NetworkDialogs + * @ingroup AccountDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_startup_card_check.h b/cockatrice/src/dialogs/dlg_startup_card_check.h index ada093df2..44fc59d58 100644 --- a/cockatrice/src/dialogs/dlg_startup_card_check.h +++ b/cockatrice/src/dialogs/dlg_startup_card_check.h @@ -1,6 +1,6 @@ /** * @file dlg_startup_card_check.h - * @ingroup NetworkDialogs + * @ingroup CardDatabaseUpdateDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_update.h b/cockatrice/src/dialogs/dlg_update.h index fd5901e39..45ae92178 100644 --- a/cockatrice/src/dialogs/dlg_update.h +++ b/cockatrice/src/dialogs/dlg_update.h @@ -1,6 +1,6 @@ /** * @file dlg_update.h - * @ingroup NetworkDialogs + * @ingroup ClientUpdateDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/dialogs/dlg_view_log.h b/cockatrice/src/dialogs/dlg_view_log.h index f8f64c561..f0b900527 100644 --- a/cockatrice/src/dialogs/dlg_view_log.h +++ b/cockatrice/src/dialogs/dlg_view_log.h @@ -1,6 +1,6 @@ /** * @file dlg_view_log.h - * @ingroup NetworkDialogs + * @ingroup ServerLogDialogs * @brief TODO: Document this. */ diff --git a/cockatrice/src/interface/theme_manager.h b/cockatrice/src/interface/theme_manager.h index c14042536..594ede2bf 100644 --- a/cockatrice/src/interface/theme_manager.h +++ b/cockatrice/src/interface/theme_manager.h @@ -1,7 +1,6 @@ /** * @file theme_manager.h - * @ingroup Core - * @ingroup Settings + * @ingroup CoreSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/chat_view/chat_view.h b/cockatrice/src/server/chat_view/chat_view.h index 87ff31642..924c2ff42 100644 --- a/cockatrice/src/server/chat_view/chat_view.h +++ b/cockatrice/src/server/chat_view/chat_view.h @@ -1,8 +1,7 @@ /** * @file chat_view.h - * @ingroup Network + * @ingroup NetworkingWidgets * @ingroup Lobby - * @ingroup Widgets * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/games_model.h b/cockatrice/src/server/games_model.h index 155ede3f5..03717bce8 100644 --- a/cockatrice/src/server/games_model.h +++ b/cockatrice/src/server/games_model.h @@ -1,7 +1,6 @@ /** * @file games_model.h * @ingroup Lobby - * @ingroup Network * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/handle_public_servers.h b/cockatrice/src/server/handle_public_servers.h index a182a70c3..f06bb3ff6 100644 --- a/cockatrice/src/server/handle_public_servers.h +++ b/cockatrice/src/server/handle_public_servers.h @@ -1,6 +1,6 @@ /** * @file handle_public_servers.h - * @ingroup Network + * @ingroup Server * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/pending_command.h b/cockatrice/src/server/pending_command.h index de96adb39..df452b10a 100644 --- a/cockatrice/src/server/pending_command.h +++ b/cockatrice/src/server/pending_command.h @@ -1,6 +1,6 @@ /** * @file pending_command.h - * @ingroup Network + * @ingroup Messages * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/remote/remote_decklist_tree_widget.h b/cockatrice/src/server/remote/remote_decklist_tree_widget.h index 8e2bdbcf8..0153f0414 100644 --- a/cockatrice/src/server/remote/remote_decklist_tree_widget.h +++ b/cockatrice/src/server/remote/remote_decklist_tree_widget.h @@ -1,6 +1,6 @@ /** * @file remote_decklist_tree_widget.h - * @ingroup Client + * @ingroup NetworkingWidgets * @ingroup DeckStorageWidgets * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/remote/remote_replay_list_tree_widget.h b/cockatrice/src/server/remote/remote_replay_list_tree_widget.h index b2e666fee..ccff71c47 100644 --- a/cockatrice/src/server/remote/remote_replay_list_tree_widget.h +++ b/cockatrice/src/server/remote/remote_replay_list_tree_widget.h @@ -2,7 +2,7 @@ * @file remote_replay_list_tree_widget.h * @ingroup DeckStorageWidgets * @ingroup Replays - * @ingroup Client + * @ingroup NetworkingWidgets * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/user/user_info_box.h b/cockatrice/src/server/user/user_info_box.h index 47dc70065..d3d926bed 100644 --- a/cockatrice/src/server/user/user_info_box.h +++ b/cockatrice/src/server/user/user_info_box.h @@ -1,6 +1,5 @@ /** * @file user_info_box.h - * @ingroup Network * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/user/user_info_connection.h b/cockatrice/src/server/user/user_info_connection.h index 8a9cf4007..90be05570 100644 --- a/cockatrice/src/server/user/user_info_connection.h +++ b/cockatrice/src/server/user/user_info_connection.h @@ -1,6 +1,6 @@ /** * @file user_info_connection.h - * @ingroup Network + * @ingroup Client * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/user/user_list_manager.h b/cockatrice/src/server/user/user_list_manager.h index fecb8c63c..b02a43808 100644 --- a/cockatrice/src/server/user/user_list_manager.h +++ b/cockatrice/src/server/user/user_list_manager.h @@ -1,6 +1,5 @@ /** * @file user_list_manager.h - * @ingroup Network * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/server/user/user_list_widget.h b/cockatrice/src/server/user/user_list_widget.h index 063bac7dc..8a1674549 100644 --- a/cockatrice/src/server/user/user_list_widget.h +++ b/cockatrice/src/server/user/user_list_widget.h @@ -1,6 +1,5 @@ /** * @file user_list_widget.h - * @ingroup Network * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/cache_settings.h b/cockatrice/src/settings/cache_settings.h index 52bf1bc12..93cd5a837 100644 --- a/cockatrice/src/settings/cache_settings.h +++ b/cockatrice/src/settings/cache_settings.h @@ -1,6 +1,5 @@ /** * @file cache_settings.h - * @ingroup Network * @ingroup Settings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/card_counter_settings.h b/cockatrice/src/settings/card_counter_settings.h index 3713f8e47..94baeb9e2 100644 --- a/cockatrice/src/settings/card_counter_settings.h +++ b/cockatrice/src/settings/card_counter_settings.h @@ -1,6 +1,6 @@ /** * @file card_counter_settings.h - * @ingroup Settings + * @ingroup GameSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/card_database_settings.h b/cockatrice/src/settings/card_database_settings.h index 0d800b664..5bc7eb59f 100644 --- a/cockatrice/src/settings/card_database_settings.h +++ b/cockatrice/src/settings/card_database_settings.h @@ -1,7 +1,7 @@ /** * @file card_database_settings.h * @ingroup CardDatabase - * @ingroup Settings + * @ingroup CardSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/card_override_settings.h b/cockatrice/src/settings/card_override_settings.h index ba4ef7095..90a1a1681 100644 --- a/cockatrice/src/settings/card_override_settings.h +++ b/cockatrice/src/settings/card_override_settings.h @@ -1,6 +1,6 @@ /** * @file card_override_settings.h - * @ingroup Settings + * @ingroup CardSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/debug_settings.h b/cockatrice/src/settings/debug_settings.h index 596708f60..2087b16b3 100644 --- a/cockatrice/src/settings/debug_settings.h +++ b/cockatrice/src/settings/debug_settings.h @@ -1,7 +1,6 @@ /** * @file debug_settings.h - * @ingroup Core - * @ingroup Settings + * @ingroup CoreSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/download_settings.h b/cockatrice/src/settings/download_settings.h index 6e212954f..a67a7f9c7 100644 --- a/cockatrice/src/settings/download_settings.h +++ b/cockatrice/src/settings/download_settings.h @@ -1,7 +1,6 @@ /** * @file download_settings.h - * @ingroup Network - * @ingroup Settings + * @ingroup NetworkSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/game_filters_settings.h b/cockatrice/src/settings/game_filters_settings.h index b533c5045..2a2c09c84 100644 --- a/cockatrice/src/settings/game_filters_settings.h +++ b/cockatrice/src/settings/game_filters_settings.h @@ -1,7 +1,7 @@ /** * @file game_filters_settings.h * @ingroup Lobby - * @ingroup Settings + * @ingroup GameSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/layouts_settings.h b/cockatrice/src/settings/layouts_settings.h index 89fec2577..5feb0f4f6 100644 --- a/cockatrice/src/settings/layouts_settings.h +++ b/cockatrice/src/settings/layouts_settings.h @@ -1,6 +1,6 @@ /** * @file layouts_settings.h - * @ingroup Settings + * @ingroup CoreSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/message_settings.h b/cockatrice/src/settings/message_settings.h index b37e812bb..265c455e1 100644 --- a/cockatrice/src/settings/message_settings.h +++ b/cockatrice/src/settings/message_settings.h @@ -1,7 +1,6 @@ /** * @file message_settings.h - * @ingroup Network - * @ingroup Settings + * @ingroup NetworkSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/recents_settings.h b/cockatrice/src/settings/recents_settings.h index 5650af349..23c8f1a9f 100644 --- a/cockatrice/src/settings/recents_settings.h +++ b/cockatrice/src/settings/recents_settings.h @@ -1,7 +1,6 @@ /** * @file recents_settings.h - * @ingroup DeckStorage - * @ingroup Settings + * @ingroup DeckSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/servers_settings.h b/cockatrice/src/settings/servers_settings.h index 19f648169..4d92c4647 100644 --- a/cockatrice/src/settings/servers_settings.h +++ b/cockatrice/src/settings/servers_settings.h @@ -1,7 +1,6 @@ /** * @file servers_settings.h - * @ingroup Network - * @ingroup Settings + * @ingroup NetworkSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/shortcut_treeview.h b/cockatrice/src/settings/shortcut_treeview.h index 07436536a..229bf2ed2 100644 --- a/cockatrice/src/settings/shortcut_treeview.h +++ b/cockatrice/src/settings/shortcut_treeview.h @@ -1,6 +1,6 @@ /** * @file shortcut_treeview.h - * @ingroup Settings + * @ingroup CoreSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/settings/shortcuts_settings.h b/cockatrice/src/settings/shortcuts_settings.h index a25379139..b6820798d 100644 --- a/cockatrice/src/settings/shortcuts_settings.h +++ b/cockatrice/src/settings/shortcuts_settings.h @@ -1,6 +1,6 @@ /** * @file shortcuts_settings.h - * @ingroup Settings + * @ingroup CoreSettings * @brief TODO: Document this. */ diff --git a/cockatrice/src/tabs/tab_account.h b/cockatrice/src/tabs/tab_account.h index e72d5df4f..4e6abb24b 100644 --- a/cockatrice/src/tabs/tab_account.h +++ b/cockatrice/src/tabs/tab_account.h @@ -1,6 +1,6 @@ /** * @file tab_account.h - * @ingroup NetworkingTabs + * @ingroup AccountTabs * @brief TODO: Document this. */ diff --git a/cockatrice/src/tabs/tab_admin.h b/cockatrice/src/tabs/tab_admin.h index 22ba9280d..60722b778 100644 --- a/cockatrice/src/tabs/tab_admin.h +++ b/cockatrice/src/tabs/tab_admin.h @@ -1,6 +1,6 @@ /** * @file tab_admin.h - * @ingroup NetworkingTabs + * @ingroup ServerTabs * @brief TODO: Document this. */ diff --git a/cockatrice/src/tabs/tab_logs.h b/cockatrice/src/tabs/tab_logs.h index f548473e1..f87739051 100644 --- a/cockatrice/src/tabs/tab_logs.h +++ b/cockatrice/src/tabs/tab_logs.h @@ -1,6 +1,6 @@ /** * @file tab_logs.h - * @ingroup NetworkingTabs + * @ingroup ServerTabs * @brief TODO: Document this. */ diff --git a/cockatrice/src/tabs/tab_message.h b/cockatrice/src/tabs/tab_message.h index ca7306622..098089e46 100644 --- a/cockatrice/src/tabs/tab_message.h +++ b/cockatrice/src/tabs/tab_message.h @@ -1,6 +1,6 @@ /** * @file tab_message.h - * @ingroup NetworkingTabs + * @ingroup MessagingTabs * @brief TODO: Document this. */ diff --git a/cockatrice/src/tabs/tab_room.h b/cockatrice/src/tabs/tab_room.h index 2c20e3273..3eb1b580f 100644 --- a/cockatrice/src/tabs/tab_room.h +++ b/cockatrice/src/tabs/tab_room.h @@ -1,6 +1,6 @@ /** * @file tab_room.h - * @ingroup NetworkingTabs + * @ingroup RoomTabs * @ingroup Lobby * @brief TODO: Document this. */ diff --git a/cockatrice/src/tabs/tab_server.h b/cockatrice/src/tabs/tab_server.h index c7d11efbc..39e55fd26 100644 --- a/cockatrice/src/tabs/tab_server.h +++ b/cockatrice/src/tabs/tab_server.h @@ -1,6 +1,6 @@ /** * @file tab_server.h - * @ingroup NetworkingTabs + * @ingroup ServerTabs * @brief TODO: Document this. */ diff --git a/doc/doxygen-groups/doc_groups.dox b/doc/doxygen-groups/doc_groups.dox index 11e50a400..953ba0e75 100644 --- a/doc/doxygen-groups/doc_groups.dox +++ b/doc/doxygen-groups/doc_groups.dox @@ -32,16 +32,25 @@ */ /** - * @defgroup ApiResponses API Responses - * @ingroup Network - * @brief Structures representing API responses. - * - * Encapsulates the data models for networking API responses, - * providing consistent interfaces for parsing and handling results. + * @defgroup ApiInterfaces API Interfaces + * @ingroup Client + * @ingroup Parsing + * @ingroup ImportExport + * @brief Interfaces for interacting with various APIs */ + /** + * @defgroup ApiResponses API Responses + * @ingroup ApiInterfaces + * @brief Structures representing API responses. + * + * Encapsulates the data models for networking API responses, + * providing consistent interfaces for parsing and handling results. + */ + /** * @defgroup ApiResponseDisplayWidgets API Response Display Widgets + * @ingroup Widgets * @ingroup ApiResponses * @brief Qt widgets for displaying API responses. * @@ -66,6 +75,13 @@ * Handles all client-side communication with the server. */ +/** + * @defgroup NetworkingWidgets Networking Widgets + * @ingroup Widgets + * @ingroup Client + * @brief Widgets related to a RemoteClient interacting with a RemoteServer. + */ + /** * @defgroup ClientUpdates Client Updates * @ingroup Client @@ -82,9 +98,10 @@ */ /** - * @defgroup Lobby Lobby & Rooms - * @ingroup Network - * @brief Multiplayer lobby and room management. + * @defgroup RoomWidgets Room Widgets + * @ingroup Widgets + * @ingroup Client + * @brief Server room management. * * Manages creation and interaction of Game lobbies and room state synchronization with the server. */ @@ -121,6 +138,7 @@ /** * @defgroup GameWidgets Game Widgets + * @ingroup Widgets * @ingroup GameUi * @brief Widgets specific to the in-game interface. * @@ -274,6 +292,7 @@ /** * @defgroup DeckEditorWidgets Deck Editor Widgets + * @ingroup Widgets * @ingroup DeckEditors * @brief Supporting widgets for deck editors. * @@ -301,6 +320,7 @@ /** * @defgroup PrintingWidgets Printing Widgets * @ingroup DeckEditorWidgets + * @ingroup Widgets * @brief Widgets for handling PrintingInfo of cards in a DeckList. * * Manages the display and editing of card printing information within a DeckList, @@ -310,24 +330,39 @@ /** * @defgroup DeckStorage Deck Storage * @ingroup Decks - * @brief Systems for storing a DeckList. + * @brief Systems for storing a DeckList on a local file system or remote service. + */ + +/** + * @defgroup LocalDeckStorage Local Deck Storage + * @ingroup DeckStorage + * @brief Systems for storing a DeckList on a local file system. * * Handles the persistence of a DeckList, providing file-based storage, * metadata tracking, and tagging functionality. */ /** - * @defgroup DeckStorageWidgets Deck Storage Widgets - * @ingroup DeckStorage + * @defgroup LocalDeckStorageWidgets Local Deck Storage Widgets + * @ingroup Widgets + * @ingroup LocalDeckStorage * @brief Widgets for browsing and managing stored DeckLists. * * Provides list and tree-based views for exploring stored DeckLists, * including tagging, searching, and preview functionality. */ + /** + * @defgroup LocalDeckStorageDialogs Local Deck Storage Dialogs + * @ingroup LocalDeckStorageWidgets + * @ingroup ImportExport + * @ingroup Lobby + * @brief Dialogs related to interacting with decks on a filesystem or in a remote location. + */ + /** * @defgroup VisualDeckStorageWidgets Visual Deck Storage Widgets - * @ingroup DeckStorageWidgets + * @ingroup LocalDeckStorageWidgets * @brief Visual widgets for DeckList storage. * * Offers graphical interfaces for browsing and interacting with a stored @@ -343,6 +378,27 @@ * to inspect the deck name, color identity, and banner card at a glance. */ +/** + * @defgroup RemoteDeckStorage Remote Deck Storage + * @ingroup DeckStorage + * @brief Systems for storing a DeckList on a remote service. + */ + +/** + * @defgroup RemoteDeckStorageWidgets Remote Deck Storage Widgets + * @ingroup Widgets + * @ingroup RemoteDeckStorage + * @ingroup ImportExport + * @ingroup Lobby + * @brief Widgets related to interacting with decks on a filesystem or in a remote location. + */ + +/** + * @defgroup RemoteDeckStorageDialogs Remote Deck Storage Dialogs + * @ingroup RemoteDeckStorageWidgets + * @brief Dialogs related to interacting with decks on a filesystem or in a remote location. + */ + /** * @defgroup ImportExport Import/Export * @ingroup DeckStorage @@ -387,6 +443,7 @@ /** * @defgroup CardWidgets Card Widgets + * @ingroup Widgets * @ingroup Cards * @brief Widgets for card display and interaction. * @@ -440,6 +497,7 @@ /** * @defgroup CardDatabaseWidgets Card Database Widgets + * @ingroup Widgets * @ingroup CardDatabase * @brief Widgets for browsing and selecting cards. * @@ -496,7 +554,32 @@ /** * @defgroup NetworkingTabs Networking Tabs * @ingroup Tabs - * @ingroup Network + * @ingroup NetworkingWidgets + * @brief Tabs related to a RemoteClient interacting with a RemoteServer. + */ + +/** + * @defgroup ServerTabs Server Tabs + * @ingroup NetworkingTabs + * @brief Tabs related to a RemoteServer. + */ + +/** + * @defgroup AccountTabs Account Tabs + * @ingroup NetworkingTabs + * @brief Tabs related to user account information. + */ + +/** + * @defgroup RoomTabs Room Tabs + * @ingroup RoomWidgets + * @brief Tabs related to a Room on a RemoteServer. + */ + +/** + * @defgroup MessagingTabs Message Tabs + * @ingroup NetworkingTabs + * @brief Tabs related to users sending messages to each other. */ /** @@ -511,8 +594,45 @@ /** * @defgroup NetworkDialogs Networking Dialogs * @ingroup Dialogs - * @ingroup Network - * @brief Dialogs related to interacting with a remote server. + * @ingroup NetworkingWidgets + * @brief Dialogs related to a RemoteClient interacting with a RemoteServer. + */ + +/** + * @defgroup ClientUpdateDialogs Client Update Dialogs + * @ingroup NetworkDialogs + * @brief Dialogs relating to the client updating. + */ + +/** + * @defgroup CardDatabaseUpdateDialogs Card Database Update Dialogs + * @ingroup NetworkDialogs + * @ingroup CardDatabaseWidgets + * @brief Dialogs relating to the CardDatabase updating. + */ + +/** + * @defgroup ConnectionDialogs Connection Dialogs + * @ingroup NetworkDialogs + * @brief Dialogs relating to the RemoteClient%s connection to a RemoteServer. + */ + +/** + * @defgroup AccountDialogs Account Dialogs + * @ingroup NetworkDialogs + * @brief Dialogs relating to account information on a RemoteServer. + */ + +/** + * @defgroup RoomDialogs + * @ingroup NetworkDialogs + * @brief Dialogs relating to a RemoteClient interacting with a Room on a RemoteServer. + */ + +/** + * @defgroup ServerLogDialogs Server Log Dialogs + * @ingroup NetworkDialogs + * @brief Dialogs relating to a RemoteClient interacting a RemoteServer%'s logs. */ /** @@ -546,6 +666,43 @@ * runtime access to user preferences and application options. */ +/** + * @defgroup SettingsWidgets Settings Widgets + * @ingroup Widgets + * @ingroup Settings + * @brief TODO: Document this + */ + +/** + * @defgroup CoreSettings Core Settings + * @ingroup Settings + * @brief TODO: Document this + */ + +/** + * @defgroup NetworkSettings Network Settings + * @ingroup Settings + * @brief TODO: Document this + */ + +/** + * @defgroup GameSettings Game Settings + * @ingroup Settings + * @brief TODO: Document this + */ + +/** + * @defgroup CardSettings Card Settings + * @ingroup Settings + * @brief TODO: Document this + */ + +/** + * @defgroup DeckSettings Deck Settings + * @ingroup Settings + * @brief TODO: Document this + */ + /* ------------------------------------------------------------------ */ /* Tests */ /* ------------------------------------------------------------------ */ @@ -557,4 +714,3 @@ * Provides unit tests, integration tests, and regression checks * to ensure stability and correctness of the Cockatrice codebase. */ -