From f8c4f774cf036f8f64b2f4caf28ea6b6239a5ced Mon Sep 17 00:00:00 2001 From: BruebachL <44814898+BruebachL@users.noreply.github.com> Date: Tue, 30 Sep 2025 12:13:32 +0200 Subject: [PATCH] [Documentation] Sort *every* file into a doxygen group. (#6198) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Sort *every* file into a doxygen group. Took 7 hours 9 minutes Took 18 seconds Took 2 minutes * Lint some ingroup definitions. Took 10 minutes Took 2 seconds * Just include the groups in the Doxyfile in this commit. Took 3 minutes * Update some group comments so they link! Took 14 minutes --------- Co-authored-by: Lukas BrĂ¼bach --- Doxyfile | 2 +- cockatrice/src/card/card_info.h | 6 + cockatrice/src/card/exact_card.h | 4 +- cockatrice/src/card/game_specific_terms.h | 6 + cockatrice/src/client/deck_editor_menu.h | 6 + cockatrice/src/client/get_text_with_max.h | 7 +- .../client/network/client_update_checker.h | 6 + .../parsers/deck_link_to_api_transformer.h | 6 + .../parsers/interface_json_deck_parser.h | 6 + .../src/client/network/release_channel.h | 6 + .../client/network/replay_timeline_widget.h | 6 + cockatrice/src/client/network/sets_model.h | 6 + .../network/spoiler_background_updater.h | 6 + cockatrice/src/client/replay_manager.h | 7 + cockatrice/src/client/sound_engine.h | 6 + cockatrice/src/client/tapped_out_interface.h | 8 + cockatrice/src/client/update_downloader.h | 8 +- cockatrice/src/database/card_database.h | 6 + .../src/database/card_database_loader.h | 6 + .../src/database/card_database_manager.h | 6 + .../src/database/card_database_querier.h | 6 + .../model/card/card_completer_proxy_model.h | 6 + .../database/model/card/card_search_model.h | 6 + .../model/card_database_display_model.h | 7 + .../src/database/model/card_database_model.h | 6 + .../model/token/token_display_model.h | 6 + .../database/model/token/token_edit_model.h | 6 + .../database/parser/card_database_parser.h | 6 + .../src/database/parser/cockatrice_xml_3.h | 6 + .../src/database/parser/cockatrice_xml_4.h | 6 + cockatrice/src/deck/custom_line_edit.h | 5 + cockatrice/src/deck/deck_list_model.h | 4 + cockatrice/src/deck/deck_loader.h | 6 + cockatrice/src/deck/deck_stats_interface.h | 8 + cockatrice/src/dialogs/dlg_connect.h | 6 + .../dialogs/dlg_convert_deck_to_cod_format.h | 8 + cockatrice/src/dialogs/dlg_create_game.h | 7 + .../src/dialogs/dlg_default_tags_editor.h | 7 + cockatrice/src/dialogs/dlg_edit_avatar.h | 6 + cockatrice/src/dialogs/dlg_edit_password.h | 6 + cockatrice/src/dialogs/dlg_edit_tokens.h | 6 + cockatrice/src/dialogs/dlg_edit_user.h | 6 + cockatrice/src/dialogs/dlg_filter_games.h | 7 + .../dialogs/dlg_forgot_password_challenge.h | 6 + .../src/dialogs/dlg_forgot_password_request.h | 6 + .../src/dialogs/dlg_forgot_password_reset.h | 6 + cockatrice/src/dialogs/dlg_load_deck.h | 7 + .../dialogs/dlg_load_deck_from_clipboard.h | 8 + .../src/dialogs/dlg_load_deck_from_website.h | 8 + cockatrice/src/dialogs/dlg_load_remote_deck.h | 8 + cockatrice/src/dialogs/dlg_manage_sets.h | 6 + cockatrice/src/dialogs/dlg_register.h | 6 + .../src/dialogs/dlg_select_set_for_cards.h | 6 + cockatrice/src/dialogs/dlg_settings.h | 6 + .../src/dialogs/dlg_startup_card_check.h | 6 + cockatrice/src/dialogs/dlg_tip_of_the_day.h | 6 + cockatrice/src/dialogs/dlg_update.h | 6 + cockatrice/src/dialogs/dlg_view_log.h | 6 + cockatrice/src/dialogs/tip_of_the_day.h | 6 + cockatrice/src/filters/deck_filter_string.h | 6 + cockatrice/src/filters/filter_builder.h | 6 + cockatrice/src/filters/filter_card.h | 6 + cockatrice/src/filters/filter_string.h | 6 + cockatrice/src/filters/filter_tree.h | 6 + cockatrice/src/filters/filter_tree_model.h | 6 + cockatrice/src/filters/syntax_help.h | 7 + cockatrice/src/game/abstract_game.h | 6 + .../src/game/board/abstract_card_drag_item.h | 6 + .../src/game/board/abstract_card_item.h | 6 + cockatrice/src/game/board/abstract_counter.h | 6 + .../src/game/board/abstract_graphics_item.h | 6 + cockatrice/src/game/board/arrow_item.h | 6 + cockatrice/src/game/board/arrow_target.h | 6 + cockatrice/src/game/board/card_drag_item.h | 6 + cockatrice/src/game/board/card_item.h | 6 + cockatrice/src/game/board/card_list.h | 6 + cockatrice/src/game/board/counter_general.h | 6 + .../src/game/board/graphics_item_type.h | 6 + .../src/game/board/translate_counter_name.h | 6 + cockatrice/src/game/deckview/deck_view.h | 6 + .../src/game/deckview/deck_view_container.h | 6 + .../deckview/tabbed_deck_view_container.h | 6 + .../src/game/dialogs/dlg_create_token.h | 6 + .../game/dialogs/dlg_move_top_cards_until.h | 6 + cockatrice/src/game/dialogs/dlg_roll_dice.h | 6 + cockatrice/src/game/game.h | 6 + cockatrice/src/game/game_event_handler.h | 6 + cockatrice/src/game/game_meta_info.h | 6 + cockatrice/src/game/game_scene.h | 6 + cockatrice/src/game/game_state.h | 6 + cockatrice/src/game/game_view.h | 6 + cockatrice/src/game/hand_counter.h | 6 + cockatrice/src/game/log/message_log_widget.h | 6 + cockatrice/src/game/phase.h | 6 + cockatrice/src/game/phases_toolbar.h | 7 + .../src/game/player/card_menu_action_type.h | 6 + .../game/player/event_processing_options.h | 6 + cockatrice/src/game/player/menu/card_menu.h | 6 + .../src/game/player/menu/custom_zone_menu.h | 6 + cockatrice/src/game/player/menu/grave_menu.h | 6 + cockatrice/src/game/player/menu/hand_menu.h | 6 + .../src/game/player/menu/library_menu.h | 6 + cockatrice/src/game/player/menu/move_menu.h | 6 + cockatrice/src/game/player/menu/player_menu.h | 6 + cockatrice/src/game/player/menu/pt_menu.h | 6 + cockatrice/src/game/player/menu/rfg_menu.h | 6 + cockatrice/src/game/player/menu/say_menu.h | 6 + .../src/game/player/menu/sideboard_menu.h | 6 + .../src/game/player/menu/utility_menu.h | 6 + cockatrice/src/game/player/player.h | 6 + cockatrice/src/game/player/player_actions.h | 7 + cockatrice/src/game/player/player_area.h | 6 + .../src/game/player/player_event_handler.h | 6 + .../src/game/player/player_graphics_item.h | 6 + cockatrice/src/game/player/player_info.h | 6 + .../src/game/player/player_list_widget.h | 6 + cockatrice/src/game/player/player_manager.h | 6 + cockatrice/src/game/player/player_target.h | 6 + cockatrice/src/game/replay.h | 7 + cockatrice/src/game/zones/card_zone.h | 6 + cockatrice/src/game/zones/hand_zone.h | 6 + .../src/game/zones/logic/card_zone_logic.h | 6 + .../src/game/zones/logic/hand_zone_logic.h | 6 + .../src/game/zones/logic/pile_zone_logic.h | 6 + .../src/game/zones/logic/stack_zone_logic.h | 6 + .../src/game/zones/logic/table_zone_logic.h | 6 + .../src/game/zones/logic/view_zone_logic.h | 6 + cockatrice/src/game/zones/pile_zone.h | 6 + cockatrice/src/game/zones/select_zone.h | 6 + cockatrice/src/game/zones/stack_zone.h | 6 + cockatrice/src/game/zones/table_zone.h | 6 + cockatrice/src/game/zones/view_zone.h | 6 + cockatrice/src/game/zones/view_zone_widget.h | 6 + .../src/interface/layouts/flow_layout.h | 6 + .../src/interface/layouts/overlap_layout.h | 6 + .../src/interface/line_edit_completer.h | 6 + .../src/interface/pixel_map_generator.h | 6 + cockatrice/src/interface/tearoff_menu.h | 6 + cockatrice/src/interface/theme_manager.h | 7 + .../additional_info/color_identity_widget.h | 6 + .../cards/additional_info/mana_cost_widget.h | 6 + .../additional_info/mana_symbol_widget.h | 6 + .../card_group_display_widget.h | 6 + .../flat_card_group_display_widget.h | 6 + .../overlapped_card_group_display_widget.h | 6 + .../widgets/cards/card_info_display_widget.h | 6 + .../widgets/cards/card_info_frame_widget.h | 6 + .../cards/card_info_picture_art_crop_widget.h | 6 + .../cards/card_info_picture_enlarged_widget.h | 7 + .../widgets/cards/card_info_picture_widget.h | 6 + ...rd_info_picture_with_text_overlay_widget.h | 7 + .../widgets/cards/card_info_text_widget.h | 6 + .../widgets/cards/card_size_widget.h | 8 + .../cards/deck_card_zone_display_widget.h | 6 + .../cards/deck_preview_card_picture_widget.h | 7 + .../deck_analytics/deck_analytics_widget.h | 6 + .../widgets/deck_analytics/mana_base_widget.h | 6 + .../deck_analytics/mana_curve_widget.h | 6 + .../deck_analytics/mana_devotion_widget.h | 6 + .../deck_editor_card_info_dock_widget.h | 7 + .../deck_editor_database_display_widget.h | 7 + .../deck_editor_deck_dock_widget.h | 7 + .../deck_editor_filter_dock_widget.h | 7 + ...eck_editor_printing_selector_dock_widget.h | 6 + .../widgets/general/background_sources.h | 6 + .../widgets/general/display/banner_widget.h | 8 + .../widgets/general/display/bar_widget.h | 7 + .../general/display/dynamic_font_size_label.h | 6 + .../display/dynamic_font_size_push_button.h | 6 + .../widgets/general/display/labeled_input.h | 6 + .../general/display/percent_bar_widget.h | 7 + .../general/display/shadow_background_label.h | 6 + .../widgets/general/home_styled_button.h | 8 +- .../interface/widgets/general/home_widget.h | 7 + .../general/layout_containers/flow_widget.h | 6 + .../overlap_control_widget.h | 6 + .../layout_containers/overlap_widget.h | 6 + .../all_zones_card_amount_widget.h | 7 + .../printing_selector/card_amount_widget.h | 7 + .../printing_selector/printing_selector.h | 6 + .../printing_selector_card_display_widget.h | 6 + .../printing_selector_card_overlay_widget.h | 6 + .../printing_selector_card_search_widget.h | 6 + .../printing_selector_card_selection_widget.h | 6 + .../printing_selector_card_sorting_widget.h | 6 + ...ame_and_collectors_number_display_widget.h | 7 + .../quick_settings/settings_button_widget.h | 7 + .../quick_settings/settings_popup_widget.h | 7 + ...ual_database_display_color_filter_widget.h | 6 + ...database_display_filter_save_load_widget.h | 6 + ...database_display_main_type_filter_widget.h | 6 + ...sual_database_display_name_filter_widget.h | 6 + ...isual_database_display_set_filter_widget.h | 6 + ..._database_display_sub_type_filter_widget.h | 6 + .../visual_database_display_widget.h | 6 + .../visual_database_filter_display_widget.h | 6 + .../visual_deck_editor_sample_hand_widget.h | 6 + .../visual_deck_editor_widget.h | 6 + ...eck_preview_color_identity_filter_widget.h | 6 + .../deck_preview_deck_tags_display_widget.h | 6 + .../deck_preview_tag_addition_widget.h | 6 + .../deck_preview/deck_preview_tag_dialog.h | 7 + .../deck_preview_tag_display_widget.h | 6 + .../deck_preview_tag_item_widget.h | 6 + .../deck_preview/deck_preview_widget.h | 6 + ...isual_deck_storage_folder_display_widget.h | 6 + ...isual_deck_storage_quick_settings_widget.h | 13 +- .../visual_deck_storage_search_widget.h | 6 + .../visual_deck_storage_sort_widget.h | 6 + .../visual_deck_storage_tag_filter_widget.h | 6 + .../visual_deck_storage_widget.h | 6 + cockatrice/src/interface/window_main.h | 5 + cockatrice/src/main.h | 6 + cockatrice/src/server/abstract_client.h | 6 + cockatrice/src/server/chat_view/chat_view.h | 8 + cockatrice/src/server/game_selector.h | 6 + cockatrice/src/server/games_model.h | 7 + cockatrice/src/server/handle_public_servers.h | 6 + cockatrice/src/server/local_client.h | 6 + cockatrice/src/server/local_server.h | 6 + .../src/server/local_server_interface.h | 6 + cockatrice/src/server/pending_command.h | 6 + cockatrice/src/server/remote/remote_client.h | 6 + .../remote/remote_decklist_tree_widget.h | 7 + .../remote/remote_replay_list_tree_widget.h | 8 + .../src/server/user/user_context_menu.h | 6 + cockatrice/src/server/user/user_info_box.h | 7 + .../src/server/user/user_info_connection.h | 6 + .../src/server/user/user_list_manager.h | 7 + cockatrice/src/server/user/user_list_proxy.h | 7 + cockatrice/src/server/user/user_list_widget.h | 7 + cockatrice/src/settings/cache_settings.h | 7 + .../src/settings/card_counter_settings.h | 6 + .../src/settings/card_database_settings.h | 7 + .../src/settings/card_override_settings.h | 6 + cockatrice/src/settings/debug_settings.h | 7 + cockatrice/src/settings/download_settings.h | 7 + .../src/settings/game_filters_settings.h | 7 + cockatrice/src/settings/layouts_settings.h | 6 + cockatrice/src/settings/message_settings.h | 7 + cockatrice/src/settings/recents_settings.h | 7 + cockatrice/src/settings/servers_settings.h | 7 + cockatrice/src/settings/settings_manager.h | 6 + cockatrice/src/settings/shortcut_treeview.h | 6 + cockatrice/src/settings/shortcuts_settings.h | 6 + .../edhrec_api_response_archidekt_links.h | 12 +- .../edhrec_average_deck_api_response.h | 6 +- .../average_deck/edhrec_deck_api_response.h | 6 + .../edhrec_api_response_card_prices.h | 6 + .../edhrec_api_response_card_container.h | 6 + .../cards/edhrec_api_response_card_details.h | 6 + .../cards/edhrec_api_response_card_list.h | 6 + ...commander_api_response_commander_details.h | 6 + .../commander/edhrec_commander_api_response.h | 6 +- ...der_api_response_average_deck_statistics.h | 6 +- .../top_cards/edhrec_top_cards_api_response.h | 6 + .../edhrec_top_commanders_api_response.h | 6 + .../top_tags/edhrec_top_tags_api_response.h | 6 + ..._api_response_card_prices_display_widget.h | 6 + ...api_response_card_details_display_widget.h | 6 + ...i_response_card_inclusion_display_widget.h | 6 + ...ec_api_response_card_list_display_widget.h | 6 + ...api_response_card_synergy_display_widget.h | 6 + ...esponse_commander_details_display_widget.h | 6 + ...ec_commander_api_response_display_widget.h | 6 + ...commander_api_response_navigation_widget.h | 6 + ...ec_top_cards_api_response_display_widget.h | 6 + ...p_commanders_api_response_display_widget.h | 6 + ...rec_top_tags_api_response_display_widget.h | 6 + cockatrice/src/tabs/api/edhrec/tab_edhrec.h | 6 + .../src/tabs/api/edhrec/tab_edhrec_main.h | 6 + cockatrice/src/tabs/tab.h | 6 + cockatrice/src/tabs/tab_account.h | 6 + cockatrice/src/tabs/tab_admin.h | 6 + cockatrice/src/tabs/tab_deck_storage.h | 7 + cockatrice/src/tabs/tab_game.h | 8 + cockatrice/src/tabs/tab_home.h | 6 + cockatrice/src/tabs/tab_logs.h | 6 + cockatrice/src/tabs/tab_message.h | 6 + cockatrice/src/tabs/tab_replays.h | 7 + cockatrice/src/tabs/tab_room.h | 7 + cockatrice/src/tabs/tab_server.h | 6 + cockatrice/src/tabs/tab_supervisor.h | 7 + .../src/tabs/tab_visual_database_display.h | 6 + .../tab_deck_storage_visual.h | 6 + cockatrice/src/utility/card_info_comparator.h | 6 + cockatrice/src/utility/card_set_comparator.h | 6 + .../deck_list_sort_filter_proxy_model.h | 6 + cockatrice/src/utility/key_signals.h | 7 + cockatrice/src/utility/levenshtein.h | 6 + cockatrice/src/utility/logger.h | 6 + cockatrice/src/utility/sequence_edit.h | 6 + common/abstract_deck_list_card_node.h | 1 + common/abstract_deck_list_node.h | 2 + common/deck_list.h | 2 + common/deck_list_card_node.h | 1 + doc/doxygen-groups/doc_groups.dox | 553 ++++++++++++++++++ 297 files changed, 2368 insertions(+), 19 deletions(-) create mode 100644 doc/doxygen-groups/doc_groups.dox diff --git a/Doxyfile b/Doxyfile index 51813aad5..298edc7f7 100644 --- a/Doxyfile +++ b/Doxyfile @@ -991,7 +991,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = .github/CONTRIBUTING.md cockatrice common doc/doxygen-extra-pages +INPUT = cockatrice common doc/doxygen-groups # This tag can be used to specify the character encoding of the source files # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/cockatrice/src/card/card_info.h b/cockatrice/src/card/card_info.h index 33ed569d5..6cb27f273 100644 --- a/cockatrice/src/card/card_info.h +++ b/cockatrice/src/card/card_info.h @@ -1,3 +1,9 @@ +/** + * @file card_info.h + * @ingroup Cards + * @brief TODO: Document this. + */ + #ifndef CARD_INFO_H #define CARD_INFO_H diff --git a/cockatrice/src/card/exact_card.h b/cockatrice/src/card/exact_card.h index a962ea076..f0ba25c02 100644 --- a/cockatrice/src/card/exact_card.h +++ b/cockatrice/src/card/exact_card.h @@ -4,7 +4,9 @@ #include "card_info.h" /** - * Identifies the card along with its exact printing + * @class ExactCard + * @ingroup Cards + * @brief Identifies the card by its CardInfoPtr along with its exact printing by its PrintingInfo. */ class ExactCard { diff --git a/cockatrice/src/card/game_specific_terms.h b/cockatrice/src/card/game_specific_terms.h index cbf3e3ef9..8f13039da 100644 --- a/cockatrice/src/card/game_specific_terms.h +++ b/cockatrice/src/card/game_specific_terms.h @@ -1,3 +1,9 @@ +/** + * @file game_specific_terms.h + * @ingroup Cards + * @brief TODO: Document this. + */ + #ifndef GAME_SPECIFIC_TERMS_H #define GAME_SPECIFIC_TERMS_H diff --git a/cockatrice/src/client/deck_editor_menu.h b/cockatrice/src/client/deck_editor_menu.h index af3dc65d5..205cf6344 100644 --- a/cockatrice/src/client/deck_editor_menu.h +++ b/cockatrice/src/client/deck_editor_menu.h @@ -1,3 +1,9 @@ +/** + * @file deck_editor_menu.h + * @ingroup DeckEditors + * @brief TODO: Document this. + */ + #ifndef DECK_EDITOR_MENU_H #define DECK_EDITOR_MENU_H diff --git a/cockatrice/src/client/get_text_with_max.h b/cockatrice/src/client/get_text_with_max.h index b6a9304ed..2e633d494 100644 --- a/cockatrice/src/client/get_text_with_max.h +++ b/cockatrice/src/client/get_text_with_max.h @@ -1,4 +1,9 @@ -// custom QInputDialog::getText implementation that allows configuration of the max length +/** + * @file get_text_with_max.h + * @ingroup UI + * @brief Custom QInputDialog::getText implementation that allows configuration of the max length + */ + #ifndef GETTEXTWITHMAX_H #define GETTEXTWITHMAX_H diff --git a/cockatrice/src/client/network/client_update_checker.h b/cockatrice/src/client/network/client_update_checker.h index 96a7213b1..4e6f279c3 100644 --- a/cockatrice/src/client/network/client_update_checker.h +++ b/cockatrice/src/client/network/client_update_checker.h @@ -1,3 +1,9 @@ +/** + * @file client_update_checker.h + * @ingroup ClientUpdate + * @brief TODO: Document this. + */ + #ifndef CLIENT_UPDATE_CHECKER_H #define CLIENT_UPDATE_CHECKER_H #include 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 dd1f4ac35..190fd5488 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,3 +1,9 @@ +/** + * @file deck_link_to_api_transformer.h + * @ingroup Network + * @brief TODO: Document this. + */ + #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 5de25dec0..ace7e1623 100644 --- a/cockatrice/src/client/network/parsers/interface_json_deck_parser.h +++ b/cockatrice/src/client/network/parsers/interface_json_deck_parser.h @@ -1,3 +1,9 @@ +/** + * @file interface_json_deck_parser.h + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef INTERFACE_JSON_DECK_PARSER_H #define INTERFACE_JSON_DECK_PARSER_H #include "../../../deck/deck_loader.h" diff --git a/cockatrice/src/client/network/release_channel.h b/cockatrice/src/client/network/release_channel.h index 0fb459969..74568c146 100644 --- a/cockatrice/src/client/network/release_channel.h +++ b/cockatrice/src/client/network/release_channel.h @@ -1,3 +1,9 @@ +/** + * @file release_channel.h + * @ingroup ClientUpdate + * @brief TODO: Document this. + */ + #ifndef RELEASECHANNEL_H #define RELEASECHANNEL_H diff --git a/cockatrice/src/client/network/replay_timeline_widget.h b/cockatrice/src/client/network/replay_timeline_widget.h index 1ff995826..aa9e03e31 100644 --- a/cockatrice/src/client/network/replay_timeline_widget.h +++ b/cockatrice/src/client/network/replay_timeline_widget.h @@ -1,3 +1,9 @@ +/** + * @file replay_timeline_widget.h + * @ingroup Replay + * @brief TODO: Document this. + */ + #ifndef REPLAY_TIMELINE_WIDGET #define REPLAY_TIMELINE_WIDGET diff --git a/cockatrice/src/client/network/sets_model.h b/cockatrice/src/client/network/sets_model.h index 70dea842e..1e4183d62 100644 --- a/cockatrice/src/client/network/sets_model.h +++ b/cockatrice/src/client/network/sets_model.h @@ -1,3 +1,9 @@ +/** + * @file sets_model.h + * @ingroup CardDatabaseModels + * @brief TODO: Document this. + */ + #ifndef SETSMODEL_H #define SETSMODEL_H diff --git a/cockatrice/src/client/network/spoiler_background_updater.h b/cockatrice/src/client/network/spoiler_background_updater.h index a29488bf2..e3d254528 100644 --- a/cockatrice/src/client/network/spoiler_background_updater.h +++ b/cockatrice/src/client/network/spoiler_background_updater.h @@ -1,3 +1,9 @@ +/** + * @file spoiler_background_updater.h + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_SPOILER_DOWNLOADER_H #define COCKATRICE_SPOILER_DOWNLOADER_H diff --git a/cockatrice/src/client/replay_manager.h b/cockatrice/src/client/replay_manager.h index 4dc7869b9..55a64768c 100644 --- a/cockatrice/src/client/replay_manager.h +++ b/cockatrice/src/client/replay_manager.h @@ -1,3 +1,10 @@ +/** + * @file replay_manager.h + * @ingroup Core + * @ingroup Replay + * @brief TODO: Document this. + */ + #ifndef REPLAY_MANAGER_H #define REPLAY_MANAGER_H diff --git a/cockatrice/src/client/sound_engine.h b/cockatrice/src/client/sound_engine.h index 851ca3928..f45cccf7d 100644 --- a/cockatrice/src/client/sound_engine.h +++ b/cockatrice/src/client/sound_engine.h @@ -1,3 +1,9 @@ +/** + * @file sound_engine.h + * @ingroup Core + * @brief TODO: Document this. + */ + #ifndef SOUNDENGINE_H #define SOUNDENGINE_H diff --git a/cockatrice/src/client/tapped_out_interface.h b/cockatrice/src/client/tapped_out_interface.h index b9eaddb23..096015bed 100644 --- a/cockatrice/src/client/tapped_out_interface.h +++ b/cockatrice/src/client/tapped_out_interface.h @@ -1,3 +1,11 @@ +/** + * @file tapped_out_interface.h + * @ingroup ImportExport + * @ingroup Parsing + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef TAPPEDOUT_INTERFACE_H #define TAPPEDOUT_INTERFACE_H diff --git a/cockatrice/src/client/update_downloader.h b/cockatrice/src/client/update_downloader.h index cafed0377..4f79f3f6d 100644 --- a/cockatrice/src/client/update_downloader.h +++ b/cockatrice/src/client/update_downloader.h @@ -1,6 +1,8 @@ -// -// Created by miguel on 28/12/15. -// +/** + * @file update_downloader.h + * @ingroup ClientUpdate + * @brief TODO: Document this. + */ #ifndef COCKATRICE_UPDATEDOWNLOADER_H #define COCKATRICE_UPDATEDOWNLOADER_H diff --git a/cockatrice/src/database/card_database.h b/cockatrice/src/database/card_database.h index a6941ee5b..f417088c3 100644 --- a/cockatrice/src/database/card_database.h +++ b/cockatrice/src/database/card_database.h @@ -1,3 +1,9 @@ +/** + * @file card_database.h + * @ingroup CardDatabase + * @brief The CardDatabase is responsible for holding the card and set maps. + */ + #ifndef CARDDATABASE_H #define CARDDATABASE_H diff --git a/cockatrice/src/database/card_database_loader.h b/cockatrice/src/database/card_database_loader.h index 37d3c4d75..030ca56d5 100644 --- a/cockatrice/src/database/card_database_loader.h +++ b/cockatrice/src/database/card_database_loader.h @@ -1,3 +1,9 @@ +/** + * @file card_database_loader.h + * @ingroup CardDatabase + * @brief The CardDatabaseLoader is responsible for populating the card database from files on disk. + */ + #ifndef COCKATRICE_CARD_DATABASE_LOADER_H #define COCKATRICE_CARD_DATABASE_LOADER_H diff --git a/cockatrice/src/database/card_database_manager.h b/cockatrice/src/database/card_database_manager.h index c87e04888..1962460fc 100644 --- a/cockatrice/src/database/card_database_manager.h +++ b/cockatrice/src/database/card_database_manager.h @@ -1,3 +1,9 @@ +/** + * @file card_database_manager.h + * @ingroup CardDatabase + * @brief The CardDatabaseManager is responsible for managing the global database singleton. + */ + #ifndef CARD_DATABASE_ACCESSOR_H #define CARD_DATABASE_ACCESSOR_H diff --git a/cockatrice/src/database/card_database_querier.h b/cockatrice/src/database/card_database_querier.h index 26c601333..c30cf49c2 100644 --- a/cockatrice/src/database/card_database_querier.h +++ b/cockatrice/src/database/card_database_querier.h @@ -1,3 +1,9 @@ +/** + * @file card_database_querier.h + * @ingroup CardDatabase + * @brief The CardDatabaseQuerier is responsible for querying the database and returning data. + */ + #ifndef COCKATRICE_CARD_DATABASE_QUERIER_H #define COCKATRICE_CARD_DATABASE_QUERIER_H diff --git a/cockatrice/src/database/model/card/card_completer_proxy_model.h b/cockatrice/src/database/model/card/card_completer_proxy_model.h index 73cf223ed..7a4626059 100644 --- a/cockatrice/src/database/model/card/card_completer_proxy_model.h +++ b/cockatrice/src/database/model/card/card_completer_proxy_model.h @@ -1,3 +1,9 @@ +/** + * @file card_completer_proxy_model.h + * @ingroup CardDatabaseModels + * @brief TODO: Document this. + */ + #ifndef CARD_COMPLETER_PROXY_MODEL_H #define CARD_COMPLETER_PROXY_MODEL_H diff --git a/cockatrice/src/database/model/card/card_search_model.h b/cockatrice/src/database/model/card/card_search_model.h index aa9939662..98d66cb5e 100644 --- a/cockatrice/src/database/model/card/card_search_model.h +++ b/cockatrice/src/database/model/card/card_search_model.h @@ -1,3 +1,9 @@ +/** + * @file card_search_model.h + * @ingroup CardDatabaseModels + * @brief TODO: Document this. + */ + #ifndef CARD_SEARCH_MODEL_H #define CARD_SEARCH_MODEL_H diff --git a/cockatrice/src/database/model/card_database_display_model.h b/cockatrice/src/database/model/card_database_display_model.h index 0515c7624..a1f9366e2 100644 --- a/cockatrice/src/database/model/card_database_display_model.h +++ b/cockatrice/src/database/model/card_database_display_model.h @@ -1,3 +1,10 @@ +/** + * @file card_database_display_model.h + * @ingroup CardDatabaseModels + * @brief The CardDatabaseDisplayModel is a QSortFilterProxyModel that allows applying filters and sorting to a + * CardDatabaseModel. + */ + #ifndef COCKATRICE_CARD_DATABASE_DISPLAY_MODEL_H #define COCKATRICE_CARD_DATABASE_DISPLAY_MODEL_H diff --git a/cockatrice/src/database/model/card_database_model.h b/cockatrice/src/database/model/card_database_model.h index fac099f5a..fc89e0572 100644 --- a/cockatrice/src/database/model/card_database_model.h +++ b/cockatrice/src/database/model/card_database_model.h @@ -1,3 +1,9 @@ +/** + * @file card_database_model.h + * @ingroup CardDatabaseModels + * @brief The CardDatabaseModel maps the cardList contained in the CardDatabase as a QAbstractListModel. + */ + #ifndef CARDDATABASEMODEL_H #define CARDDATABASEMODEL_H diff --git a/cockatrice/src/database/model/token/token_display_model.h b/cockatrice/src/database/model/token/token_display_model.h index 50d351653..5d3b63a36 100644 --- a/cockatrice/src/database/model/token/token_display_model.h +++ b/cockatrice/src/database/model/token/token_display_model.h @@ -1,3 +1,9 @@ +/** + * @file token_display_model.h + * @ingroup CardDatabaseModels + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_TOKEN_DISPLAY_MODEL_H #define COCKATRICE_TOKEN_DISPLAY_MODEL_H diff --git a/cockatrice/src/database/model/token/token_edit_model.h b/cockatrice/src/database/model/token/token_edit_model.h index 3ae2278cf..50c7eb642 100644 --- a/cockatrice/src/database/model/token/token_edit_model.h +++ b/cockatrice/src/database/model/token/token_edit_model.h @@ -1,3 +1,9 @@ +/** + * @file token_edit_model.h + * @ingroup CardDatabaseModels + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_TOKEN_EDIT_MODEL_H #define COCKATRICE_TOKEN_EDIT_MODEL_H diff --git a/cockatrice/src/database/parser/card_database_parser.h b/cockatrice/src/database/parser/card_database_parser.h index 9b3950427..15a86fbfa 100644 --- a/cockatrice/src/database/parser/card_database_parser.h +++ b/cockatrice/src/database/parser/card_database_parser.h @@ -1,3 +1,9 @@ +/** + * @file card_database_parser.h + * @ingroup CardDatabaseParsers + * @brief The ICardDatabaseParser defines the base interface for parser sub-classes. + */ + #ifndef CARDDATABASE_PARSER_H #define CARDDATABASE_PARSER_H diff --git a/cockatrice/src/database/parser/cockatrice_xml_3.h b/cockatrice/src/database/parser/cockatrice_xml_3.h index f8c060774..90130f4d1 100644 --- a/cockatrice/src/database/parser/cockatrice_xml_3.h +++ b/cockatrice/src/database/parser/cockatrice_xml_3.h @@ -1,3 +1,9 @@ +/** + * @file cockatrice_xml_3.h + * @ingroup CardDatabaseParsers + * @brief The CockatriceXml3Parser is capable of parsing version 3 of the Cockatrice XML Schema. + */ + #ifndef COCKATRICE_XML3_H #define COCKATRICE_XML3_H diff --git a/cockatrice/src/database/parser/cockatrice_xml_4.h b/cockatrice/src/database/parser/cockatrice_xml_4.h index 9cd200441..389e23712 100644 --- a/cockatrice/src/database/parser/cockatrice_xml_4.h +++ b/cockatrice/src/database/parser/cockatrice_xml_4.h @@ -1,3 +1,9 @@ +/** + * @file cockatrice_xml_4.h + * @ingroup CardDatabaseParsers + * @brief The CockatriceXml4Parser is capable of parsing version 4 of the Cockatrice XML Schema. + */ + #ifndef COCKATRICE_XML4_H #define COCKATRICE_XML4_H diff --git a/cockatrice/src/deck/custom_line_edit.h b/cockatrice/src/deck/custom_line_edit.h index 075ec012e..2026c1c1c 100644 --- a/cockatrice/src/deck/custom_line_edit.h +++ b/cockatrice/src/deck/custom_line_edit.h @@ -1,3 +1,8 @@ +/** + * @file custom_line_edit.h + * @ingroup UI + * @brief TODO: Document this. + */ #ifndef CUSTOMLINEEDIT_H #define CUSTOMLINEEDIT_H diff --git a/cockatrice/src/deck/deck_list_model.h b/cockatrice/src/deck/deck_list_model.h index de9790c61..28d95a632 100644 --- a/cockatrice/src/deck/deck_list_model.h +++ b/cockatrice/src/deck/deck_list_model.h @@ -25,6 +25,8 @@ enum DeckListModelGroupCriteria }; /** + * @class DecklistModelCardNode + * @ingroup DeckModels * @brief Adapter node that wraps a DecklistCardNode for use in the DeckListModel tree. * * This class forwards all property accessors (name, number, provider ID, set info, etc.) @@ -103,6 +105,8 @@ public: }; /** + * @class DeckListModel + * @ingroup DeckModels * @brief Qt model representing a decklist for use in views (tree/table). * * DeckListModel is a QAbstractItemModel that exposes the structure of a deck diff --git a/cockatrice/src/deck/deck_loader.h b/cockatrice/src/deck/deck_loader.h index 16e14f3d2..53c4ef434 100644 --- a/cockatrice/src/deck/deck_loader.h +++ b/cockatrice/src/deck/deck_loader.h @@ -1,3 +1,9 @@ +/** + * @file deck_loader.h + * @ingroup ImportExport + * @brief TODO: Document this. + */ + #ifndef DECK_LOADER_H #define DECK_LOADER_H diff --git a/cockatrice/src/deck/deck_stats_interface.h b/cockatrice/src/deck/deck_stats_interface.h index 80a8a0770..ccb530b5a 100644 --- a/cockatrice/src/deck/deck_stats_interface.h +++ b/cockatrice/src/deck/deck_stats_interface.h @@ -1,3 +1,11 @@ +/** + * @file deck_stats_interface.h + * @ingroup ImportExport + * @ingroup Parsing + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef DECKSTATS_INTERFACE_H #define DECKSTATS_INTERFACE_H diff --git a/cockatrice/src/dialogs/dlg_connect.h b/cockatrice/src/dialogs/dlg_connect.h index 119e3b816..89d7a6943 100644 --- a/cockatrice/src/dialogs/dlg_connect.h +++ b/cockatrice/src/dialogs/dlg_connect.h @@ -1,3 +1,9 @@ +/** + * @file dlg_connect.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_CONNECT_H #define DLG_CONNECT_H 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 88a19591e..e608c247e 100644 --- a/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h +++ b/cockatrice/src/dialogs/dlg_convert_deck_to_cod_format.h @@ -1,3 +1,11 @@ +/** + * @file dlg_convert_deck_to_cod_format.h + * @ingroup Dialogs + * @ingroup DeckStorageWidgets + * @ingroup ImportExport + * @brief TODO: Document this. + */ + #ifndef DIALOG_CONVERT_DECK_TO_COD_FORMAT_H #define DIALOG_CONVERT_DECK_TO_COD_FORMAT_H diff --git a/cockatrice/src/dialogs/dlg_create_game.h b/cockatrice/src/dialogs/dlg_create_game.h index ae10bf01b..24b972fe0 100644 --- a/cockatrice/src/dialogs/dlg_create_game.h +++ b/cockatrice/src/dialogs/dlg_create_game.h @@ -1,3 +1,10 @@ +/** + * @file dlg_create_game.h + * @ingroup NetworkDialogs + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef DLG_CREATEGAME_H #define DLG_CREATEGAME_H diff --git a/cockatrice/src/dialogs/dlg_default_tags_editor.h b/cockatrice/src/dialogs/dlg_default_tags_editor.h index 8dd58e018..b552ae737 100644 --- a/cockatrice/src/dialogs/dlg_default_tags_editor.h +++ b/cockatrice/src/dialogs/dlg_default_tags_editor.h @@ -1,3 +1,10 @@ +/** + * @file dlg_default_tags_editor.h + * @ingroup Dialogs + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #ifndef DLG_DEFAULT_TAGS_EDITOR_H #define DLG_DEFAULT_TAGS_EDITOR_H diff --git a/cockatrice/src/dialogs/dlg_edit_avatar.h b/cockatrice/src/dialogs/dlg_edit_avatar.h index 8a84349e2..c96d56571 100644 --- a/cockatrice/src/dialogs/dlg_edit_avatar.h +++ b/cockatrice/src/dialogs/dlg_edit_avatar.h @@ -1,3 +1,9 @@ +/** + * @file dlg_edit_avatar.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_EDITAVATAR_H #define DLG_EDITAVATAR_H diff --git a/cockatrice/src/dialogs/dlg_edit_password.h b/cockatrice/src/dialogs/dlg_edit_password.h index e3fcce6ec..8f7b2b9aa 100644 --- a/cockatrice/src/dialogs/dlg_edit_password.h +++ b/cockatrice/src/dialogs/dlg_edit_password.h @@ -1,3 +1,9 @@ +/** + * @file dlg_edit_password.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_EDITPASSWORD_H #define DLG_EDITPASSWORD_H diff --git a/cockatrice/src/dialogs/dlg_edit_tokens.h b/cockatrice/src/dialogs/dlg_edit_tokens.h index be09032da..ce3f6d7d4 100644 --- a/cockatrice/src/dialogs/dlg_edit_tokens.h +++ b/cockatrice/src/dialogs/dlg_edit_tokens.h @@ -1,3 +1,9 @@ +/** + * @file dlg_edit_tokens.h + * @ingroup GameDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_EDIT_TOKENS_H #define DLG_EDIT_TOKENS_H diff --git a/cockatrice/src/dialogs/dlg_edit_user.h b/cockatrice/src/dialogs/dlg_edit_user.h index db2ca60ac..1a01d563a 100644 --- a/cockatrice/src/dialogs/dlg_edit_user.h +++ b/cockatrice/src/dialogs/dlg_edit_user.h @@ -1,3 +1,9 @@ +/** + * @file dlg_edit user.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_EDITUSER_H #define DLG_EDITUSER_H diff --git a/cockatrice/src/dialogs/dlg_filter_games.h b/cockatrice/src/dialogs/dlg_filter_games.h index d805755d9..1205a89f2 100644 --- a/cockatrice/src/dialogs/dlg_filter_games.h +++ b/cockatrice/src/dialogs/dlg_filter_games.h @@ -1,3 +1,10 @@ +/** + * @file dlg_filter_games.h + * @ingroup Lobby + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_FILTER_GAMES_H #define DLG_FILTER_GAMES_H diff --git a/cockatrice/src/dialogs/dlg_forgot_password_challenge.h b/cockatrice/src/dialogs/dlg_forgot_password_challenge.h index 73fb44c33..fdb9514c0 100644 --- a/cockatrice/src/dialogs/dlg_forgot_password_challenge.h +++ b/cockatrice/src/dialogs/dlg_forgot_password_challenge.h @@ -1,3 +1,9 @@ +/** + * @file dlg_forgot_password_challenge.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_FORGOTPASSWORDCHALLENGE_H #define DLG_FORGOTPASSWORDCHALLENGE_H diff --git a/cockatrice/src/dialogs/dlg_forgot_password_request.h b/cockatrice/src/dialogs/dlg_forgot_password_request.h index 8d267042a..a45f6f200 100644 --- a/cockatrice/src/dialogs/dlg_forgot_password_request.h +++ b/cockatrice/src/dialogs/dlg_forgot_password_request.h @@ -1,3 +1,9 @@ +/** + * @file dlg_forgot_password_request.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_FORGOTPASSWORDREQUEST_H #define DLG_FORGOTPASSWORDREQUEST_H diff --git a/cockatrice/src/dialogs/dlg_forgot_password_reset.h b/cockatrice/src/dialogs/dlg_forgot_password_reset.h index e523e19c3..40d29cf94 100644 --- a/cockatrice/src/dialogs/dlg_forgot_password_reset.h +++ b/cockatrice/src/dialogs/dlg_forgot_password_reset.h @@ -1,3 +1,9 @@ +/** + * @file dlg_forgot_password_reset.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_FORGOTPASSWORDRESET_H #define DLG_FORGOTPASSWORDRESET_H diff --git a/cockatrice/src/dialogs/dlg_load_deck.h b/cockatrice/src/dialogs/dlg_load_deck.h index 13df97995..9d2ad2924 100644 --- a/cockatrice/src/dialogs/dlg_load_deck.h +++ b/cockatrice/src/dialogs/dlg_load_deck.h @@ -1,3 +1,10 @@ +/** + * @file dlg_load_deck.h + * @ingroup Dialogs + * @ingroup ImportExport + * @ingroup Lobby + * @brief TODO: Document this. + */ #ifndef DLG_LOAD_DECK_H #define DLG_LOAD_DECK_H diff --git a/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h b/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h index ce2ccf720..755cf9f77 100644 --- a/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h +++ b/cockatrice/src/dialogs/dlg_load_deck_from_clipboard.h @@ -1,3 +1,11 @@ +/** + * @file dlg_load_deck_from_clipboard.h + * @ingroup Dialogs + * @ingroup ImportExport + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef DLG_LOAD_DECK_FROM_CLIPBOARD_H #define DLG_LOAD_DECK_FROM_CLIPBOARD_H diff --git a/cockatrice/src/dialogs/dlg_load_deck_from_website.h b/cockatrice/src/dialogs/dlg_load_deck_from_website.h index 5810c8ecc..6e51eb736 100644 --- a/cockatrice/src/dialogs/dlg_load_deck_from_website.h +++ b/cockatrice/src/dialogs/dlg_load_deck_from_website.h @@ -1,3 +1,11 @@ +/** + * @file dlg_load_deck_from_website.h + * @ingroup Dialogs + * @ingroup ImportExport + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef DLG_LOAD_DECK_FROM_WEBSITE_H #define DLG_LOAD_DECK_FROM_WEBSITE_H diff --git a/cockatrice/src/dialogs/dlg_load_remote_deck.h b/cockatrice/src/dialogs/dlg_load_remote_deck.h index 54be44c77..f997bbb77 100644 --- a/cockatrice/src/dialogs/dlg_load_remote_deck.h +++ b/cockatrice/src/dialogs/dlg_load_remote_deck.h @@ -1,3 +1,11 @@ +/** + * @file dlg_load_remote_deck.h + * @ingroup Dialogs + * @ingroup ImportExport + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef DLG_STARTGAME_H #define DLG_STARTGAME_H diff --git a/cockatrice/src/dialogs/dlg_manage_sets.h b/cockatrice/src/dialogs/dlg_manage_sets.h index 50e29043b..c3a3c2455 100644 --- a/cockatrice/src/dialogs/dlg_manage_sets.h +++ b/cockatrice/src/dialogs/dlg_manage_sets.h @@ -1,3 +1,9 @@ +/** + * @file dlg_manage_sets.h + * @ingroup Dialogs + * @brief TODO: Document this. + */ + #ifndef DLG_MANAGE_SETS_H #define DLG_MANAGE_SETS_H diff --git a/cockatrice/src/dialogs/dlg_register.h b/cockatrice/src/dialogs/dlg_register.h index 1d87212bf..89bb7930f 100644 --- a/cockatrice/src/dialogs/dlg_register.h +++ b/cockatrice/src/dialogs/dlg_register.h @@ -1,3 +1,9 @@ +/** + * @file dlg_register.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_REGISTER_H #define DLG_REGISTER_H diff --git a/cockatrice/src/dialogs/dlg_select_set_for_cards.h b/cockatrice/src/dialogs/dlg_select_set_for_cards.h index 8b7b79a9f..77f9bd077 100644 --- a/cockatrice/src/dialogs/dlg_select_set_for_cards.h +++ b/cockatrice/src/dialogs/dlg_select_set_for_cards.h @@ -1,3 +1,9 @@ +/** + * @file dlg_select_set_for_cards.h + * @ingroup Dialogs + * @brief TODO: Document this. + */ + #ifndef DLG_SELECT_SET_FOR_CARDS_H #define DLG_SELECT_SET_FOR_CARDS_H diff --git a/cockatrice/src/dialogs/dlg_settings.h b/cockatrice/src/dialogs/dlg_settings.h index d21bf69a9..bf8dbd2a5 100644 --- a/cockatrice/src/dialogs/dlg_settings.h +++ b/cockatrice/src/dialogs/dlg_settings.h @@ -1,3 +1,9 @@ +/** + * @file dlg_settings.h + * @ingroup Dialogs + * @brief TODO: Document this. + */ + #ifndef DLG_SETTINGS_H #define DLG_SETTINGS_H diff --git a/cockatrice/src/dialogs/dlg_startup_card_check.h b/cockatrice/src/dialogs/dlg_startup_card_check.h index cb7acd280..ada093df2 100644 --- a/cockatrice/src/dialogs/dlg_startup_card_check.h +++ b/cockatrice/src/dialogs/dlg_startup_card_check.h @@ -1,3 +1,9 @@ +/** + * @file dlg_startup_card_check.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_STARTUP_CARD_CHECK_H #define DLG_STARTUP_CARD_CHECK_H diff --git a/cockatrice/src/dialogs/dlg_tip_of_the_day.h b/cockatrice/src/dialogs/dlg_tip_of_the_day.h index 4a7d86354..46598fb02 100644 --- a/cockatrice/src/dialogs/dlg_tip_of_the_day.h +++ b/cockatrice/src/dialogs/dlg_tip_of_the_day.h @@ -1,3 +1,9 @@ +/** + * @file dlg_tip_of_the_day.h + * @ingroup Dialogs + * @brief TODO: Document this. + */ + #ifndef DLG_TIPOFDAY_H #define DLG_TIPOFDAY_H diff --git a/cockatrice/src/dialogs/dlg_update.h b/cockatrice/src/dialogs/dlg_update.h index 3ac86dee1..fd5901e39 100644 --- a/cockatrice/src/dialogs/dlg_update.h +++ b/cockatrice/src/dialogs/dlg_update.h @@ -1,3 +1,9 @@ +/** + * @file dlg_update.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_UPDATE_H #define DLG_UPDATE_H diff --git a/cockatrice/src/dialogs/dlg_view_log.h b/cockatrice/src/dialogs/dlg_view_log.h index 26d6ad5e1..f8f64c561 100644 --- a/cockatrice/src/dialogs/dlg_view_log.h +++ b/cockatrice/src/dialogs/dlg_view_log.h @@ -1,3 +1,9 @@ +/** + * @file dlg_view_log.h + * @ingroup NetworkDialogs + * @brief TODO: Document this. + */ + #ifndef DLG_VIEWLOG_H #define DLG_VIEWLOG_H diff --git a/cockatrice/src/dialogs/tip_of_the_day.h b/cockatrice/src/dialogs/tip_of_the_day.h index 32792391d..1cb0cf6fb 100644 --- a/cockatrice/src/dialogs/tip_of_the_day.h +++ b/cockatrice/src/dialogs/tip_of_the_day.h @@ -1,3 +1,9 @@ +/** + * @file tip_of_the_day.h + * @ingroup Dialogs + * @brief TODO: Document this. + */ + #ifndef TIP_OF_DAY_H #define TIP_OF_DAY_H diff --git a/cockatrice/src/filters/deck_filter_string.h b/cockatrice/src/filters/deck_filter_string.h index 37e19b3ba..15782b3ad 100644 --- a/cockatrice/src/filters/deck_filter_string.h +++ b/cockatrice/src/filters/deck_filter_string.h @@ -1,3 +1,9 @@ +/** + * @file deck_filter_string.h + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #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 45ae24839..74872e3cd 100644 --- a/cockatrice/src/filters/filter_builder.h +++ b/cockatrice/src/filters/filter_builder.h @@ -1,3 +1,9 @@ +/** + * @file filter_builder.h + * @ingroup CardDatabaseModelFilters + * @brief TODO: Document this. + */ + #ifndef FILTERBUILDER_H #define FILTERBUILDER_H diff --git a/cockatrice/src/filters/filter_card.h b/cockatrice/src/filters/filter_card.h index 210d5c062..86cb0e196 100644 --- a/cockatrice/src/filters/filter_card.h +++ b/cockatrice/src/filters/filter_card.h @@ -1,3 +1,9 @@ +/** + * @file filter_card.h + * @ingroup CardDatabaseModelFilters + * @brief TODO: Document this. + */ + #ifndef CARDFILTER_H #define CARDFILTER_H diff --git a/cockatrice/src/filters/filter_string.h b/cockatrice/src/filters/filter_string.h index 149710d00..f2b8ce006 100644 --- a/cockatrice/src/filters/filter_string.h +++ b/cockatrice/src/filters/filter_string.h @@ -1,3 +1,9 @@ +/** + * @file filter_string.h + * @ingroup CardDatabaseModelFilters + * @brief TODO: Document this. + */ + #ifndef FILTER_STRING_H #define FILTER_STRING_H diff --git a/cockatrice/src/filters/filter_tree.h b/cockatrice/src/filters/filter_tree.h index a1c015e20..40a6ec54c 100644 --- a/cockatrice/src/filters/filter_tree.h +++ b/cockatrice/src/filters/filter_tree.h @@ -1,3 +1,9 @@ +/** + * @file filter_tree.h + * @ingroup CardDatabaseModelFilters + * @brief TODO: Document this. + */ + #ifndef FILTERTREE_H #define FILTERTREE_H diff --git a/cockatrice/src/filters/filter_tree_model.h b/cockatrice/src/filters/filter_tree_model.h index 89547e7a2..9e407f748 100644 --- a/cockatrice/src/filters/filter_tree_model.h +++ b/cockatrice/src/filters/filter_tree_model.h @@ -1,3 +1,9 @@ +/** + * @file filter_tree_model.h + * @ingroup CardDatabaseModelFilters + * @brief TODO: Document this. + */ + #ifndef FILTERTREEMODEL_H #define FILTERTREEMODEL_H diff --git a/cockatrice/src/filters/syntax_help.h b/cockatrice/src/filters/syntax_help.h index 911c2fdf0..7e5ef3e0e 100644 --- a/cockatrice/src/filters/syntax_help.h +++ b/cockatrice/src/filters/syntax_help.h @@ -1,3 +1,10 @@ +/** + * @file syntax_help.h + * @ingroup CardDatabaseModelFilters + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #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 386b2ee8e..08c25772c 100644 --- a/cockatrice/src/game/abstract_game.h +++ b/cockatrice/src/game/abstract_game.h @@ -1,3 +1,9 @@ +/** + * @file abstract_game.h + * @ingroup GameLogic + * @brief TODO: Document this. + */ + #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 a411a24d1..64e329474 100644 --- a/cockatrice/src/game/board/abstract_card_drag_item.h +++ b/cockatrice/src/game/board/abstract_card_drag_item.h @@ -1,3 +1,9 @@ +/** + * @file abstract_card_drag_item.h + * @ingroup GameGraphicsCards + * @brief TODO: Document this. + */ + #ifndef ABSTRACTCARDDRAGITEM_H #define ABSTRACTCARDDRAGITEM_H diff --git a/cockatrice/src/game/board/abstract_card_item.h b/cockatrice/src/game/board/abstract_card_item.h index 755735383..7ec843575 100644 --- a/cockatrice/src/game/board/abstract_card_item.h +++ b/cockatrice/src/game/board/abstract_card_item.h @@ -1,3 +1,9 @@ +/** + * @file abstract_card_item.h + * @ingroup GameGraphicsCards + * @brief TODO: Document this. + */ + #ifndef ABSTRACTCARDITEM_H #define ABSTRACTCARDITEM_H diff --git a/cockatrice/src/game/board/abstract_counter.h b/cockatrice/src/game/board/abstract_counter.h index dca167ffa..4c39340fa 100644 --- a/cockatrice/src/game/board/abstract_counter.h +++ b/cockatrice/src/game/board/abstract_counter.h @@ -1,3 +1,9 @@ +/** + * @file abstract_counter.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #ifndef COUNTER_H #define COUNTER_H diff --git a/cockatrice/src/game/board/abstract_graphics_item.h b/cockatrice/src/game/board/abstract_graphics_item.h index eaa0b881a..93b9bff1b 100644 --- a/cockatrice/src/game/board/abstract_graphics_item.h +++ b/cockatrice/src/game/board/abstract_graphics_item.h @@ -1,3 +1,9 @@ +/** + * @file abstract_graphics_item.h + * @ingroup GameGraphics + * @brief TODO: Document this. + */ + #ifndef ABSTRACTGRAPHICSITEM_H #define ABSTRACTGRAPHICSITEM_H diff --git a/cockatrice/src/game/board/arrow_item.h b/cockatrice/src/game/board/arrow_item.h index fe5669eb3..6015123e1 100644 --- a/cockatrice/src/game/board/arrow_item.h +++ b/cockatrice/src/game/board/arrow_item.h @@ -1,3 +1,9 @@ +/** + * @file arrow_item.h + * @ingroup GameGraphics + * @brief TODO: Document this. + */ + #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 a4ef6895d..d2f0a6a32 100644 --- a/cockatrice/src/game/board/arrow_target.h +++ b/cockatrice/src/game/board/arrow_target.h @@ -1,3 +1,9 @@ +/** + * @file arrow_target.h + * @ingroup GameGraphics + * @brief TODO: Document this. + */ + #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 794fd6ed3..257fde150 100644 --- a/cockatrice/src/game/board/card_drag_item.h +++ b/cockatrice/src/game/board/card_drag_item.h @@ -1,3 +1,9 @@ +/** + * @file card_drag_item.h + * @ingroup GameGraphicsCards + * @brief TODO: Document this. + */ + #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 65c870afb..5408a5f3a 100644 --- a/cockatrice/src/game/board/card_item.h +++ b/cockatrice/src/game/board/card_item.h @@ -1,3 +1,9 @@ +/** + * @file card_item.h + * @ingroup GameGraphicsCards + * @brief TODO: Document this. + */ + #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 d719b9a7e..07be33b32 100644 --- a/cockatrice/src/game/board/card_list.h +++ b/cockatrice/src/game/board/card_list.h @@ -1,3 +1,9 @@ +/** + * @file card_list.h + * @ingroup GameLogicCards + * @brief TODO: Document this. + */ + #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 dcf93c72c..3db1d7bb4 100644 --- a/cockatrice/src/game/board/counter_general.h +++ b/cockatrice/src/game/board/counter_general.h @@ -1,3 +1,9 @@ +/** + * @file counter_general.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #ifndef COUNTER_GENERAL_H #define COUNTER_GENERAL_H diff --git a/cockatrice/src/game/board/graphics_item_type.h b/cockatrice/src/game/board/graphics_item_type.h index eb81cc3aa..c48ae4ed6 100644 --- a/cockatrice/src/game/board/graphics_item_type.h +++ b/cockatrice/src/game/board/graphics_item_type.h @@ -1,3 +1,9 @@ +/** + * @file graphics_item_type.h + * @ingroup GameGraphics + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_GRAPHICS_ITEM_TYPE_H #define COCKATRICE_GRAPHICS_ITEM_TYPE_H diff --git a/cockatrice/src/game/board/translate_counter_name.h b/cockatrice/src/game/board/translate_counter_name.h index a098a8a7d..fdb277c11 100644 --- a/cockatrice/src/game/board/translate_counter_name.h +++ b/cockatrice/src/game/board/translate_counter_name.h @@ -1,3 +1,9 @@ +/** + * @file translate_counter_name.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #ifndef TRANSLATECOUNTERNAME_H #define TRANSLATECOUNTERNAME_H diff --git a/cockatrice/src/game/deckview/deck_view.h b/cockatrice/src/game/deckview/deck_view.h index 2cdfbbe93..06fb7294a 100644 --- a/cockatrice/src/game/deckview/deck_view.h +++ b/cockatrice/src/game/deckview/deck_view.h @@ -1,3 +1,9 @@ +/** + * @file deck_view.h + * @ingroup Lobby + * @brief TODO: Document this. + */ + #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 0221570af..36474b4c2 100644 --- a/cockatrice/src/game/deckview/deck_view_container.h +++ b/cockatrice/src/game/deckview/deck_view_container.h @@ -1,3 +1,9 @@ +/** + * @file deck_view_container.h + * @ingroup Lobby + * @brief TODO: Document this. + */ + #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 4b4769ece..c34eef1ef 100644 --- a/cockatrice/src/game/deckview/tabbed_deck_view_container.h +++ b/cockatrice/src/game/deckview/tabbed_deck_view_container.h @@ -1,3 +1,9 @@ +/** + * @file tabbed_deck_view_container.h + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef TABBED_DECK_VIEW_CONTAINER_H #define TABBED_DECK_VIEW_CONTAINER_H #include "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 df00e3d75..a777f6b97 100644 --- a/cockatrice/src/game/dialogs/dlg_create_token.h +++ b/cockatrice/src/game/dialogs/dlg_create_token.h @@ -1,3 +1,9 @@ +/** + * @file dlg_create_token.h + * @ingroup GameDialogs + * @brief TODO: Document this. + */ + #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 d41d029d6..00d437bcc 100644 --- a/cockatrice/src/game/dialogs/dlg_move_top_cards_until.h +++ b/cockatrice/src/game/dialogs/dlg_move_top_cards_until.h @@ -1,3 +1,9 @@ +/** + * @file dlg_move_top_cards_until.h + * @ingroup GameDialogs + * @brief TODO: Document this. + */ + #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 2bd77749f..69edd0757 100644 --- a/cockatrice/src/game/dialogs/dlg_roll_dice.h +++ b/cockatrice/src/game/dialogs/dlg_roll_dice.h @@ -1,3 +1,9 @@ +/** + * @file dlg_roll_dice.h + * @ingroup GameDialogs + * @brief TODO: Document this. + */ + #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 123d18378..96ebbae4d 100644 --- a/cockatrice/src/game/game.h +++ b/cockatrice/src/game/game.h @@ -1,3 +1,9 @@ +/** + * @file game.h + * @ingroup GameLogic + * @brief TODO: Document this. + */ + #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 4270bed74..4f44cd83e 100644 --- a/cockatrice/src/game/game_event_handler.h +++ b/cockatrice/src/game/game_event_handler.h @@ -1,3 +1,9 @@ +/** + * @file game_event_handler.h + * @ingroup GameLogic + * @brief TODO: Document this. + */ + #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 dbf193e0c..e3c0c22e0 100644 --- a/cockatrice/src/game/game_meta_info.h +++ b/cockatrice/src/game/game_meta_info.h @@ -1,3 +1,9 @@ +/** + * @file game_meta_info.h + * @ingroup GameLogic + * @brief TODO: Document this. + */ + #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 0ee3b1a81..6b44fbadb 100644 --- a/cockatrice/src/game/game_scene.h +++ b/cockatrice/src/game/game_scene.h @@ -1,3 +1,9 @@ +/** + * @file game_scene.h + * @ingroup GameGraphics + * @brief TODO: Document this. + */ + #ifndef GAMESCENE_H #define GAMESCENE_H diff --git a/cockatrice/src/game/game_state.h b/cockatrice/src/game/game_state.h index 6edf579b0..0ad24633c 100644 --- a/cockatrice/src/game/game_state.h +++ b/cockatrice/src/game/game_state.h @@ -1,3 +1,9 @@ +/** + * @file game_state.h + * @ingroup GameLogic + * @brief TODO: Document this. + */ + #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 19771298d..72df9cd08 100644 --- a/cockatrice/src/game/game_view.h +++ b/cockatrice/src/game/game_view.h @@ -1,3 +1,9 @@ +/** + * @file game_view.h + * @ingroup GameGraphics + * @brief TODO: Document this. + */ + #ifndef GAMEVIEW_H #define GAMEVIEW_H diff --git a/cockatrice/src/game/hand_counter.h b/cockatrice/src/game/hand_counter.h index d1879b03d..cd2b0fe81 100644 --- a/cockatrice/src/game/hand_counter.h +++ b/cockatrice/src/game/hand_counter.h @@ -1,3 +1,9 @@ +/** + * @file hand_counter.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #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 b7b1c7902..128d8ba0e 100644 --- a/cockatrice/src/game/log/message_log_widget.h +++ b/cockatrice/src/game/log/message_log_widget.h @@ -1,3 +1,9 @@ +/** + * @file message_log_widget.h + * @ingroup GameWidgets + * @brief TODO: Document this. + */ + #ifndef MESSAGELOGWIDGET_H #define MESSAGELOGWIDGET_H diff --git a/cockatrice/src/game/phase.h b/cockatrice/src/game/phase.h index 217f13f0f..6e451161e 100644 --- a/cockatrice/src/game/phase.h +++ b/cockatrice/src/game/phase.h @@ -1,3 +1,9 @@ +/** + * @file phase.h + * @ingroup GameLogic + * @brief TODO: Document this. + */ + #ifndef PHASE_H #define PHASE_H diff --git a/cockatrice/src/game/phases_toolbar.h b/cockatrice/src/game/phases_toolbar.h index 1191d6a79..83290205d 100644 --- a/cockatrice/src/game/phases_toolbar.h +++ b/cockatrice/src/game/phases_toolbar.h @@ -1,3 +1,10 @@ +/** + * @file phases_toolbar.h + * @ingroup GameGraphics + * @ingroup GameWidgets + * @brief TODO: Document this. + */ + #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 157164024..aec6d6397 100644 --- a/cockatrice/src/game/player/card_menu_action_type.h +++ b/cockatrice/src/game/player/card_menu_action_type.h @@ -1,3 +1,9 @@ +/** + * @file card_menu_action_type.h + * @ingroup GameMenusPlayers + * @brief TODO: Document this. + */ + #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 c5c345ebc..3e743bdb3 100644 --- a/cockatrice/src/game/player/event_processing_options.h +++ b/cockatrice/src/game/player/event_processing_options.h @@ -1,3 +1,9 @@ +/** + * @file event_processing_options.h + * @ingroup GameLogicPlayers + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_EVENT_PROCESSING_OPTIONS_H #define COCKATRICE_EVENT_PROCESSING_OPTIONS_H diff --git a/cockatrice/src/game/player/menu/card_menu.h b/cockatrice/src/game/player/menu/card_menu.h index 931d0249f..d42cda5fb 100644 --- a/cockatrice/src/game/player/menu/card_menu.h +++ b/cockatrice/src/game/player/menu/card_menu.h @@ -1,3 +1,9 @@ +/** + * @file card_menu.h + * @ingroup GameMenusCards + * @brief TODO: Document this. + */ + #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 cf7b13f23..0944029f4 100644 --- a/cockatrice/src/game/player/menu/custom_zone_menu.h +++ b/cockatrice/src/game/player/menu/custom_zone_menu.h @@ -1,3 +1,9 @@ +/** + * @file custom_zone_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #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 1f5ea5966..c3127b09c 100644 --- a/cockatrice/src/game/player/menu/grave_menu.h +++ b/cockatrice/src/game/player/menu/grave_menu.h @@ -1,3 +1,9 @@ +/** + * @file grave_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #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 968832cc6..cca6b74cc 100644 --- a/cockatrice/src/game/player/menu/hand_menu.h +++ b/cockatrice/src/game/player/menu/hand_menu.h @@ -1,3 +1,9 @@ +/** + * @file hand_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #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 9914a99a5..d9e58640c 100644 --- a/cockatrice/src/game/player/menu/library_menu.h +++ b/cockatrice/src/game/player/menu/library_menu.h @@ -1,3 +1,9 @@ +/** + * @file library_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #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 f7780d2e8..5bf657fa4 100644 --- a/cockatrice/src/game/player/menu/move_menu.h +++ b/cockatrice/src/game/player/menu/move_menu.h @@ -1,3 +1,9 @@ +/** + * @file move_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_MOVE_MENU_H #define COCKATRICE_MOVE_MENU_H #include diff --git a/cockatrice/src/game/player/menu/player_menu.h b/cockatrice/src/game/player/menu/player_menu.h index a89b6a927..968487e31 100644 --- a/cockatrice/src/game/player/menu/player_menu.h +++ b/cockatrice/src/game/player/menu/player_menu.h @@ -1,3 +1,9 @@ +/** + * @file player_menu.h + * @ingroup GameMenusPlayers + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_PLAYER_MENU_H #define COCKATRICE_PLAYER_MENU_H diff --git a/cockatrice/src/game/player/menu/pt_menu.h b/cockatrice/src/game/player/menu/pt_menu.h index f6ceab990..44112e54f 100644 --- a/cockatrice/src/game/player/menu/pt_menu.h +++ b/cockatrice/src/game/player/menu/pt_menu.h @@ -1,3 +1,9 @@ +/** + * @file pt_menu.h + * @ingroup GameMenusCards + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_PT_MENU_H #define COCKATRICE_PT_MENU_H #include diff --git a/cockatrice/src/game/player/menu/rfg_menu.h b/cockatrice/src/game/player/menu/rfg_menu.h index 0d9700f39..268bc0719 100644 --- a/cockatrice/src/game/player/menu/rfg_menu.h +++ b/cockatrice/src/game/player/menu/rfg_menu.h @@ -1,3 +1,9 @@ +/** + * @file rfg_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #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 2df84e78a..5dbde2277 100644 --- a/cockatrice/src/game/player/menu/say_menu.h +++ b/cockatrice/src/game/player/menu/say_menu.h @@ -1,3 +1,9 @@ +/** + * @file say_menu.h + * @ingroup GameMenusPlayers + * @brief TODO: Document this. + */ + #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 a2e85776e..22d5a2d69 100644 --- a/cockatrice/src/game/player/menu/sideboard_menu.h +++ b/cockatrice/src/game/player/menu/sideboard_menu.h @@ -1,3 +1,9 @@ +/** + * @file sideboard_menu.h + * @ingroup GameMenusZones + * @brief TODO: Document this. + */ + #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 ce5005180..ff57e7252 100644 --- a/cockatrice/src/game/player/menu/utility_menu.h +++ b/cockatrice/src/game/player/menu/utility_menu.h @@ -1,3 +1,9 @@ +/** + * @file utility_menu.h + * @ingroup GameMenusPlayers + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_UTILITY_MENU_H #define COCKATRICE_UTILITY_MENU_H diff --git a/cockatrice/src/game/player/player.h b/cockatrice/src/game/player/player.h index 7226f165b..8047f514e 100644 --- a/cockatrice/src/game/player/player.h +++ b/cockatrice/src/game/player/player.h @@ -1,3 +1,9 @@ +/** + * @file player.h + * @ingroup GameLogicPlayers + * @brief TODO: Document this. + */ + #ifndef PLAYER_H #define PLAYER_H diff --git a/cockatrice/src/game/player/player_actions.h b/cockatrice/src/game/player/player_actions.h index a694ff5f8..b6bc34352 100644 --- a/cockatrice/src/game/player/player_actions.h +++ b/cockatrice/src/game/player/player_actions.h @@ -1,3 +1,10 @@ +/** + * @file player_actions.h + * @ingroup GameLogicActions + * @ingroup GameLogicPlayers + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_PLAYER_ACTIONS_H #define COCKATRICE_PLAYER_ACTIONS_H #include "event_processing_options.h" diff --git a/cockatrice/src/game/player/player_area.h b/cockatrice/src/game/player/player_area.h index c0b689713..ea8dc98e1 100644 --- a/cockatrice/src/game/player/player_area.h +++ b/cockatrice/src/game/player/player_area.h @@ -1,3 +1,9 @@ +/** + * @file player_area.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #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 8df6cf299..e7d47b0de 100644 --- a/cockatrice/src/game/player/player_event_handler.h +++ b/cockatrice/src/game/player/player_event_handler.h @@ -1,3 +1,9 @@ +/** + * @file player_event_handler.h + * @ingroup GameLogicPlayers + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_PLAYER_EVENT_HANDLER_H #define COCKATRICE_PLAYER_EVENT_HANDLER_H #include "event_processing_options.h" diff --git a/cockatrice/src/game/player/player_graphics_item.h b/cockatrice/src/game/player/player_graphics_item.h index 70f42ba79..cba664dd9 100644 --- a/cockatrice/src/game/player/player_graphics_item.h +++ b/cockatrice/src/game/player/player_graphics_item.h @@ -1,3 +1,9 @@ +/** + * @file player_graphics_item.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_PLAYER_GRAPHICS_ITEM_H #define COCKATRICE_PLAYER_GRAPHICS_ITEM_H #include "../game_scene.h" diff --git a/cockatrice/src/game/player/player_info.h b/cockatrice/src/game/player/player_info.h index a8759b151..e649b1584 100644 --- a/cockatrice/src/game/player/player_info.h +++ b/cockatrice/src/game/player/player_info.h @@ -1,3 +1,9 @@ +/** + * @file player_info.h + * @ingroup GameLogicPlayers + * @brief TODO: Document this. + */ + #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 ef5ceb212..8f1487563 100644 --- a/cockatrice/src/game/player/player_list_widget.h +++ b/cockatrice/src/game/player/player_list_widget.h @@ -1,3 +1,9 @@ +/** + * @file player_list_widget.h + * @ingroup GameWidgets + * @brief TODO: Document this. + */ + #ifndef PLAYERLISTWIDGET_H #define PLAYERLISTWIDGET_H diff --git a/cockatrice/src/game/player/player_manager.h b/cockatrice/src/game/player/player_manager.h index 32f4a5753..2c257f7b4 100644 --- a/cockatrice/src/game/player/player_manager.h +++ b/cockatrice/src/game/player/player_manager.h @@ -1,3 +1,9 @@ +/** + * @file player_manager.h + * @ingroup GameLogicPlayers + * @brief TODO: Document this. + */ + #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 7c6f61020..bf26838c3 100644 --- a/cockatrice/src/game/player/player_target.h +++ b/cockatrice/src/game/player/player_target.h @@ -1,3 +1,9 @@ +/** + * @file player_target.h + * @ingroup GameGraphicsPlayers + * @brief TODO: Document this. + */ + #ifndef PLAYERTARGET_H #define PLAYERTARGET_H diff --git a/cockatrice/src/game/replay.h b/cockatrice/src/game/replay.h index bfad6731b..301f47580 100644 --- a/cockatrice/src/game/replay.h +++ b/cockatrice/src/game/replay.h @@ -1,3 +1,10 @@ +/** + * @file replay.h + * @ingroup GameLogic + * @ingroup Replay + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_REPLAY_H #define COCKATRICE_REPLAY_H diff --git a/cockatrice/src/game/zones/card_zone.h b/cockatrice/src/game/zones/card_zone.h index 1034c4668..f489915e2 100644 --- a/cockatrice/src/game/zones/card_zone.h +++ b/cockatrice/src/game/zones/card_zone.h @@ -1,3 +1,9 @@ +/** + * @file card_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef CARDZONE_H #define CARDZONE_H diff --git a/cockatrice/src/game/zones/hand_zone.h b/cockatrice/src/game/zones/hand_zone.h index a5e06819e..1cee40372 100644 --- a/cockatrice/src/game/zones/hand_zone.h +++ b/cockatrice/src/game/zones/hand_zone.h @@ -1,3 +1,9 @@ +/** + * @file hand_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef HANDZONE_H #define HANDZONE_H diff --git a/cockatrice/src/game/zones/logic/card_zone_logic.h b/cockatrice/src/game/zones/logic/card_zone_logic.h index 166f63506..9be654d22 100644 --- a/cockatrice/src/game/zones/logic/card_zone_logic.h +++ b/cockatrice/src/game/zones/logic/card_zone_logic.h @@ -1,3 +1,9 @@ +/** + * @file card_zone_logic.h + * @ingroup GameLogicZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_CARD_ZONE_LOGIC_H #define COCKATRICE_CARD_ZONE_LOGIC_H diff --git a/cockatrice/src/game/zones/logic/hand_zone_logic.h b/cockatrice/src/game/zones/logic/hand_zone_logic.h index aebe6e03f..8f34cc851 100644 --- a/cockatrice/src/game/zones/logic/hand_zone_logic.h +++ b/cockatrice/src/game/zones/logic/hand_zone_logic.h @@ -1,3 +1,9 @@ +/** + * @file hand_zone_logic.h + * @ingroup GameLogicZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_HAND_ZONE_LOGIC_H #define COCKATRICE_HAND_ZONE_LOGIC_H #include "card_zone_logic.h" diff --git a/cockatrice/src/game/zones/logic/pile_zone_logic.h b/cockatrice/src/game/zones/logic/pile_zone_logic.h index 104ce42b5..498d0d4a2 100644 --- a/cockatrice/src/game/zones/logic/pile_zone_logic.h +++ b/cockatrice/src/game/zones/logic/pile_zone_logic.h @@ -1,3 +1,9 @@ +/** + * @file pile_zone_logic.h + * @ingroup GameLogicZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_PILE_ZONE_LOGIC_H #define COCKATRICE_PILE_ZONE_LOGIC_H #include "card_zone_logic.h" diff --git a/cockatrice/src/game/zones/logic/stack_zone_logic.h b/cockatrice/src/game/zones/logic/stack_zone_logic.h index 709d0c87a..81b9d6969 100644 --- a/cockatrice/src/game/zones/logic/stack_zone_logic.h +++ b/cockatrice/src/game/zones/logic/stack_zone_logic.h @@ -1,3 +1,9 @@ +/** + * @file stack_zone_logic.h + * @ingroup GameLogicZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_STACK_ZONE_LOGIC_H #define COCKATRICE_STACK_ZONE_LOGIC_H #include "card_zone_logic.h" diff --git a/cockatrice/src/game/zones/logic/table_zone_logic.h b/cockatrice/src/game/zones/logic/table_zone_logic.h index a3ce3480b..e173bc637 100644 --- a/cockatrice/src/game/zones/logic/table_zone_logic.h +++ b/cockatrice/src/game/zones/logic/table_zone_logic.h @@ -1,3 +1,9 @@ +/** + * @file table_zone_logic.h + * @ingroup GameLogicZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_TABLE_ZONE_LOGIC_H #define COCKATRICE_TABLE_ZONE_LOGIC_H #include "card_zone_logic.h" diff --git a/cockatrice/src/game/zones/logic/view_zone_logic.h b/cockatrice/src/game/zones/logic/view_zone_logic.h index f5139dfaf..6bd5ecc8d 100644 --- a/cockatrice/src/game/zones/logic/view_zone_logic.h +++ b/cockatrice/src/game/zones/logic/view_zone_logic.h @@ -1,3 +1,9 @@ +/** + * @file view_zone_logic.h + * @ingroup GameLogicZones + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_VIEW_ZONE_LOGIC_H #define COCKATRICE_VIEW_ZONE_LOGIC_H #include "card_zone_logic.h" diff --git a/cockatrice/src/game/zones/pile_zone.h b/cockatrice/src/game/zones/pile_zone.h index 9ea05fa5d..5bfc50880 100644 --- a/cockatrice/src/game/zones/pile_zone.h +++ b/cockatrice/src/game/zones/pile_zone.h @@ -1,3 +1,9 @@ +/** + * @file pile_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef PILEZONE_H #define PILEZONE_H diff --git a/cockatrice/src/game/zones/select_zone.h b/cockatrice/src/game/zones/select_zone.h index eabd8b370..d6fd3e10e 100644 --- a/cockatrice/src/game/zones/select_zone.h +++ b/cockatrice/src/game/zones/select_zone.h @@ -1,3 +1,9 @@ +/** + * @file select_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef SELECTZONE_H #define SELECTZONE_H diff --git a/cockatrice/src/game/zones/stack_zone.h b/cockatrice/src/game/zones/stack_zone.h index 16dab22bb..7c98f5128 100644 --- a/cockatrice/src/game/zones/stack_zone.h +++ b/cockatrice/src/game/zones/stack_zone.h @@ -1,3 +1,9 @@ +/** + * @file stack_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef STACKZONE_H #define STACKZONE_H diff --git a/cockatrice/src/game/zones/table_zone.h b/cockatrice/src/game/zones/table_zone.h index 155ac7ab3..e196fe943 100644 --- a/cockatrice/src/game/zones/table_zone.h +++ b/cockatrice/src/game/zones/table_zone.h @@ -1,3 +1,9 @@ +/** + * @file table_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef TABLEZONE_H #define TABLEZONE_H diff --git a/cockatrice/src/game/zones/view_zone.h b/cockatrice/src/game/zones/view_zone.h index 2cb22ba5c..e452ecedd 100644 --- a/cockatrice/src/game/zones/view_zone.h +++ b/cockatrice/src/game/zones/view_zone.h @@ -1,3 +1,9 @@ +/** + * @file view_zone.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef ZONEVIEWERZONE_H #define ZONEVIEWERZONE_H diff --git a/cockatrice/src/game/zones/view_zone_widget.h b/cockatrice/src/game/zones/view_zone_widget.h index ae282435d..862026b21 100644 --- a/cockatrice/src/game/zones/view_zone_widget.h +++ b/cockatrice/src/game/zones/view_zone_widget.h @@ -1,3 +1,9 @@ +/** + * @file view_zone_widget.h + * @ingroup GameGraphicsZones + * @brief TODO: Document this. + */ + #ifndef ZONEVIEWWIDGET_H #define ZONEVIEWWIDGET_H diff --git a/cockatrice/src/interface/layouts/flow_layout.h b/cockatrice/src/interface/layouts/flow_layout.h index 19f696d1c..f4c9e3001 100644 --- a/cockatrice/src/interface/layouts/flow_layout.h +++ b/cockatrice/src/interface/layouts/flow_layout.h @@ -1,3 +1,9 @@ +/** + * @file flow_layout.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef FLOW_LAYOUT_H #define FLOW_LAYOUT_H diff --git a/cockatrice/src/interface/layouts/overlap_layout.h b/cockatrice/src/interface/layouts/overlap_layout.h index ab823222a..47209a2ec 100644 --- a/cockatrice/src/interface/layouts/overlap_layout.h +++ b/cockatrice/src/interface/layouts/overlap_layout.h @@ -1,3 +1,9 @@ +/** + * @file overlap_layout.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef OVERLAP_LAYOUT_H #define OVERLAP_LAYOUT_H diff --git a/cockatrice/src/interface/line_edit_completer.h b/cockatrice/src/interface/line_edit_completer.h index 28b176665..1b2ca14d6 100644 --- a/cockatrice/src/interface/line_edit_completer.h +++ b/cockatrice/src/interface/line_edit_completer.h @@ -1,3 +1,9 @@ +/** + * @file line_edit_completer.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef LINEEDITCOMPLETER_H #define LINEEDITCOMPLETER_H diff --git a/cockatrice/src/interface/pixel_map_generator.h b/cockatrice/src/interface/pixel_map_generator.h index 0380de5ee..dcc4f689f 100644 --- a/cockatrice/src/interface/pixel_map_generator.h +++ b/cockatrice/src/interface/pixel_map_generator.h @@ -1,3 +1,9 @@ +/** + * @file pixel_map_generator.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef PIXMAPGENERATOR_H #define PIXMAPGENERATOR_H diff --git a/cockatrice/src/interface/tearoff_menu.h b/cockatrice/src/interface/tearoff_menu.h index 1c1258f5f..30a2542e4 100644 --- a/cockatrice/src/interface/tearoff_menu.h +++ b/cockatrice/src/interface/tearoff_menu.h @@ -1,3 +1,9 @@ +/** + * @file tearoff_menu.h + * @ingroup GameMenus + * @brief TODO: Document this. + */ + #pragma once #include "../settings/cache_settings.h" diff --git a/cockatrice/src/interface/theme_manager.h b/cockatrice/src/interface/theme_manager.h index 20854b961..c14042536 100644 --- a/cockatrice/src/interface/theme_manager.h +++ b/cockatrice/src/interface/theme_manager.h @@ -1,3 +1,10 @@ +/** + * @file theme_manager.h + * @ingroup Core + * @ingroup Settings + * @brief TODO: Document this. + */ + #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 6a2f4c180..bb6447035 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,3 +1,9 @@ +/** + * @file color_identity_widget.h + * @ingroup CardExtraInfoWidgets + * @brief TODO: Document this. + */ + #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 e9d1ce20d..e4aac81c4 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,3 +1,9 @@ +/** + * @file mana_cost_widget.h + * @ingroup CardExtraInfoWidgets + * @brief TODO: Document this. + */ + #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 02aaf6087..4c5ad8a0b 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,3 +1,9 @@ +/** + * @file mana_symbol_widget.h + * @ingroup CardExtraInfoWidgets + * @brief TODO: Document this. + */ + #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 14ac494cf..0b74d5c3f 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,3 +1,9 @@ +/** + * @file card_group_display_widget.h + * @ingroup DeckEditorCardGroupWidgets + * @brief TODO: Document this. + */ + #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 0a0fe85ed..8b536c5e5 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,3 +1,9 @@ +/** + * @file flat_card_group_display_widget.h + * @ingroup DeckEditorCardGroupWidgets + * @brief TODO: Document this. + */ + #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 0cba41172..1440c37e7 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,3 +1,9 @@ +/** + * @file overlapped_card_group_display_widget.h + * @ingroup DeckEditorCardGroupWidgets + * @brief TODO: Document this. + */ + #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 070dcf835..ed2e03114 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_display_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file card_info_display_widget.h + * @ingroup CardWidgets + * @brief TODO: Document this. + */ + #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 b23c447bf..65fd0a514 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_frame_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_frame_widget.h @@ -1,3 +1,9 @@ +/** + * @file card_info_frame_widget.h + * @ingroup CardWidgets + * @brief TODO: Document this. + */ + #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 8b25af5a8..aed951cc6 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,3 +1,9 @@ +/** + * @file card_info_picture_art_crop_widget.h + * @ingroup CardWidgets + * @brief TODO: Document this. + */ + #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 6a2628847..07ecd1aab 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 @@ -1,3 +1,10 @@ +/** + * @file card_info_picture_enlarged_widget.h + * @ingroup CardWigets + * @ingroup DeckEditorWidgets + * @brief TODO: Document this. + */ + #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 f70104898..ce918a33e 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_picture_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_picture_widget.h @@ -1,3 +1,9 @@ +/** + * @file card_info_picture_widget.h + * @ingroup CardWidgets + * @brief TODO: Document this. + */ + #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 97cee1a8c..91c44cbb1 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 @@ -1,3 +1,10 @@ +/** + * @file card_info_picture_with_text_overlay_widget.h + * @ingroup CardWidgets + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #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 903bd541f..bd161dc22 100644 --- a/cockatrice/src/interface/widgets/cards/card_info_text_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_info_text_widget.h @@ -1,3 +1,9 @@ +/** + * @file card_info_text_widget.h + * @ingroup CardWidgets + * @brief TODO: Document this. + */ + #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 1631fa562..638c263ea 100644 --- a/cockatrice/src/interface/widgets/cards/card_size_widget.h +++ b/cockatrice/src/interface/widgets/cards/card_size_widget.h @@ -1,3 +1,11 @@ +/** + * @file card_size_widget.h + * @ingroup CardWidgets + * @ingroup DeckEditorWidgets + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #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 e71d0792b..79ddebf6a 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,3 +1,9 @@ +/** + * @file deck_card_zone_display_widget.h + * @ingroup DeckEditorWidgets + * @brief TODO: Document this. + */ + #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 568ab0f51..c4339da22 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 @@ -1,3 +1,10 @@ +/** + * @file deck_preview_card_picture_widget.h + * @ingroup CardWidgets + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef DECK_PREVIEW_CARD_PICTURE_WIDGET_H #define DECK_PREVIEW_CARD_PICTURE_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_analytics/deck_analytics_widget.h b/cockatrice/src/interface/widgets/deck_analytics/deck_analytics_widget.h index 4e9ce36ba..f2ae805d1 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/deck_analytics_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/deck_analytics_widget.h @@ -1,3 +1,9 @@ +/** + * @file deck_analytics_widget.h + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #ifndef DECK_ANALYTICS_WIDGET_H #define DECK_ANALYTICS_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_analytics/mana_base_widget.h b/cockatrice/src/interface/widgets/deck_analytics/mana_base_widget.h index ce79bc77b..c0d970db2 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/mana_base_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/mana_base_widget.h @@ -1,3 +1,9 @@ +/** + * @file mana_base_widget.h + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #ifndef MANA_BASE_WIDGET_H #define MANA_BASE_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_analytics/mana_curve_widget.h b/cockatrice/src/interface/widgets/deck_analytics/mana_curve_widget.h index 186f59371..e025df091 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/mana_curve_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/mana_curve_widget.h @@ -1,3 +1,9 @@ +/** + * @file mana_curve_widget.h + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #ifndef MANA_CURVE_WIDGET_H #define MANA_CURVE_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_analytics/mana_devotion_widget.h b/cockatrice/src/interface/widgets/deck_analytics/mana_devotion_widget.h index 36b99813e..003770b51 100644 --- a/cockatrice/src/interface/widgets/deck_analytics/mana_devotion_widget.h +++ b/cockatrice/src/interface/widgets/deck_analytics/mana_devotion_widget.h @@ -1,3 +1,9 @@ +/** + * @file mana_devotion_widget.h + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #ifndef MANA_DEVOTION_WIDGET_H #define MANA_DEVOTION_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_editor_card_info_dock_widget.h b/cockatrice/src/interface/widgets/deck_editor/deck_editor_card_info_dock_widget.h index 799e7512d..dc31d58a7 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_editor_card_info_dock_widget.h +++ b/cockatrice/src/interface/widgets/deck_editor/deck_editor_card_info_dock_widget.h @@ -1,3 +1,10 @@ +/** + * @file deck_editor_card_info_dock_widget.h + * @ingroup DeckEditorWidgets + * @brief A Deck Editor DockWidget that displays a CardInfoFrameWidget, which shows detailed information about a card, + * such as the picture or various attributes. + */ + #ifndef DECK_EDITOR_CARD_INFO_DOCK_WIDGET_H #define DECK_EDITOR_CARD_INFO_DOCK_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_editor_database_display_widget.h b/cockatrice/src/interface/widgets/deck_editor/deck_editor_database_display_widget.h index 3944b03f6..a2f803e2c 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_editor_database_display_widget.h +++ b/cockatrice/src/interface/widgets/deck_editor/deck_editor_database_display_widget.h @@ -1,3 +1,10 @@ +/** + * @file deck_editor_database_display_widget.h + * @ingroup DeckEditorWidgets + * @ingroup CardDatabaseWidgets + * @brief A Deck Editor Widget that displays a QTreeView of a CardDatabaseModel. + */ + #ifndef DECK_EDITOR_DATABASE_DISPLAY_WIDGET_H #define DECK_EDITOR_DATABASE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.h b/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.h index 2fbea169a..3cb9bf5e9 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.h +++ b/cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.h @@ -1,3 +1,10 @@ +/** + * @file deck_editor_deck_dock_widget.h + * @ingroup DeckEditorWidgets + * @brief A Deck Editor DockWidget that displays several Qt Editors to modify various deck attributes as well as a + * QTreeView of the DeckListModel. + */ + #ifndef DECK_EDITOR_DECK_DOCK_WIDGET_H #define DECK_EDITOR_DECK_DOCK_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_editor_filter_dock_widget.h b/cockatrice/src/interface/widgets/deck_editor/deck_editor_filter_dock_widget.h index 25c2d79e2..7357e489f 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_editor_filter_dock_widget.h +++ b/cockatrice/src/interface/widgets/deck_editor/deck_editor_filter_dock_widget.h @@ -1,3 +1,10 @@ +/** + * @file deck_editor_filter_dock_widget.h + * @ingroup DeckEditorWidgets + * @ingroup CardDatabaseWidgets + * @brief A Deck Editor DockWidget that displays and allows modifying filters applied to the CardDatabaseDisplayModel. + */ + #ifndef DECK_EDITOR_FILTER_DOCK_WIDGET_H #define DECK_EDITOR_FILTER_DOCK_WIDGET_H diff --git a/cockatrice/src/interface/widgets/deck_editor/deck_editor_printing_selector_dock_widget.h b/cockatrice/src/interface/widgets/deck_editor/deck_editor_printing_selector_dock_widget.h index ffc4297cb..efb3e6c6b 100644 --- a/cockatrice/src/interface/widgets/deck_editor/deck_editor_printing_selector_dock_widget.h +++ b/cockatrice/src/interface/widgets/deck_editor/deck_editor_printing_selector_dock_widget.h @@ -1,3 +1,9 @@ +/** + * @file deck_editor_printing_selector_dock_widget.h + * @ingroup DeckEditorWidgets + * @brief A Deck Editor DockWidget that displays a PrintingSelector, which allows choosing different printings. + */ + #ifndef DECK_EDITOR_PRINTING_SELECTOR_DOCK_WIDGET_H #define DECK_EDITOR_PRINTING_SELECTOR_DOCK_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/background_sources.h b/cockatrice/src/interface/widgets/general/background_sources.h index 2b4cb64cc..15bf1d377 100644 --- a/cockatrice/src/interface/widgets/general/background_sources.h +++ b/cockatrice/src/interface/widgets/general/background_sources.h @@ -1,3 +1,9 @@ +/** + * @file background_sources.h + * @ingroup UI + * @brief TODO: Document this. + */ + #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 2f7db1726..d43693903 100644 --- a/cockatrice/src/interface/widgets/general/display/banner_widget.h +++ b/cockatrice/src/interface/widgets/general/display/banner_widget.h @@ -1,3 +1,11 @@ +/** + * @file banner_widget.h + * @ingroup Widgets + * @ingroup DeckEditorCardGroupWidgets + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #ifndef BANNER_WIDGET_H #define BANNER_WIDGET_H diff --git a/cockatrice/src/interface/widgets/general/display/bar_widget.h b/cockatrice/src/interface/widgets/general/display/bar_widget.h index e32d773e8..672f5b7ac 100644 --- a/cockatrice/src/interface/widgets/general/display/bar_widget.h +++ b/cockatrice/src/interface/widgets/general/display/bar_widget.h @@ -1,3 +1,10 @@ +/** + * @file bar_widget.h + * @ingroup Widgets + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #ifndef BAR_WIDGET_H #define 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 2f66227e9..ca3043d10 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,3 +1,9 @@ +/** + * @file dynamic_font_size_label.h + * @ingroup Widgets + * @brief TODO: Document this. + */ + #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 eb33a7d80..19e67fd28 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,3 +1,9 @@ +/** + * @file dynamic_font_size_push_button.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 078db95f8..8424e09f0 100644 --- a/cockatrice/src/interface/widgets/general/display/labeled_input.h +++ b/cockatrice/src/interface/widgets/general/display/labeled_input.h @@ -1,3 +1,9 @@ +/** + * @file labeled_input.h + * @ingroup DeckEditorCardGroupWidgets + * @brief TODO: Document this. + */ + #ifndef LABELED_INPUT_H #define LABELED_INPUT_H diff --git a/cockatrice/src/interface/widgets/general/display/percent_bar_widget.h b/cockatrice/src/interface/widgets/general/display/percent_bar_widget.h index c782b448b..9ebdb172a 100644 --- a/cockatrice/src/interface/widgets/general/display/percent_bar_widget.h +++ b/cockatrice/src/interface/widgets/general/display/percent_bar_widget.h @@ -1,3 +1,10 @@ +/** + * @file percent_bar_widget.h + * @ingroup Widgets + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #ifndef PERCENT_BAR_WIDGET_H #define PERCENT_BAR_WIDGET_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 992c8e81c..3483452f5 100644 --- a/cockatrice/src/interface/widgets/general/display/shadow_background_label.h +++ b/cockatrice/src/interface/widgets/general/display/shadow_background_label.h @@ -1,3 +1,9 @@ +/** + * @file shadow_background_label.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 2ff30fc81..a053993da 100644 --- a/cockatrice/src/interface/widgets/general/home_styled_button.h +++ b/cockatrice/src/interface/widgets/general/home_styled_button.h @@ -1,6 +1,8 @@ -// -// Created by ascor on 6/15/25. -// +/** + * @file home_styled_button.h + * @ingroup Widgets + * @brief TODO: Document this. + */ #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 1e870d1b6..2c22bc29b 100644 --- a/cockatrice/src/interface/widgets/general/home_widget.h +++ b/cockatrice/src/interface/widgets/general/home_widget.h @@ -1,3 +1,10 @@ +/** + * @file home_widget.h + * @ingroup Core + * @ingroup Widgets + * @brief TODO: Document this. + */ + #ifndef HOME_WIDGET_H #define HOME_WIDGET_H #include "../../../server/abstract_client.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 246b5a274..d9fa49937 100644 --- a/cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h +++ b/cockatrice/src/interface/widgets/general/layout_containers/flow_widget.h @@ -1,3 +1,9 @@ +/** + * @file flow_widget.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef FLOW_WIDGET_H #define FLOW_WIDGET_H #include "../../../layouts/flow_layout.h" 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 eecf304a2..b2c19a07f 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,3 +1,9 @@ +/** + * @file overlap_control_widget.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef OVERLAP_CONTROL_WIDGET_H #define OVERLAP_CONTROL_WIDGET_H #include "../display/labeled_input.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 2d2a94132..9ac6ac80e 100644 --- a/cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h +++ b/cockatrice/src/interface/widgets/general/layout_containers/overlap_widget.h @@ -1,3 +1,9 @@ +/** + * @file overlap_widget.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef OVERLAP_WIDGET_H #define OVERLAP_WIDGET_H 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 9f45660ee..b666a126d 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 @@ -1,3 +1,10 @@ +/** + * @file all_zones_card_amount_widget.h + * @ingroup CardExtraInfoWidgets + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #ifndef ALL_ZONES_CARD_AMOUNT_WIDGET_H #define ALL_ZONES_CARD_AMOUNT_WIDGET_H #include "../../../deck/deck_list_model.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 fbf159312..49321ed6e 100644 --- a/cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h +++ b/cockatrice/src/interface/widgets/printing_selector/card_amount_widget.h @@ -1,3 +1,10 @@ +/** + * @file card_amount_widget.h + * @ingroup CardExtraInfoWidgets + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 5afdd00f4..1fd27498a 100644 --- a/cockatrice/src/interface/widgets/printing_selector/printing_selector.h +++ b/cockatrice/src/interface/widgets/printing_selector/printing_selector.h @@ -1,3 +1,9 @@ +/** + * @file printing_selector.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 b7e27547d..4bd686cb3 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,3 +1,9 @@ +/** + * @file printing_selector_card_display_widget.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 d981f5f9a..84f029f11 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,3 +1,9 @@ +/** + * @file printing_selector_card_overlay_widget.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 737d9b7ba..821addd01 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,3 +1,9 @@ +/** + * @file printing_selector_card_search_widget.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 89229bda8..a1176a76c 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,3 +1,9 @@ +/** + * @file printing_selector_card_selection_widget.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 c91b363c9..d0faea4ac 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,3 +1,9 @@ +/** + * @file printing_selector_card_sorting_widget.h + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 dfaa98caa..057b42a66 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 @@ -1,3 +1,10 @@ +/** + * @file set_name_and_collectors_number_display_widget.h + * @ingroup CardExtraInfoWidgets + * @ingroup PrintingWidgets + * @brief TODO: Document this. + */ + #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 3483b7625..d93078126 100644 --- a/cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h +++ b/cockatrice/src/interface/widgets/quick_settings/settings_button_widget.h @@ -1,3 +1,10 @@ +/** + * @file settings_button_widget.h + * @ingroup Widgets + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SETTINGS_BUTTON_WIDGET_H #define SETTINGS_BUTTON_WIDGET_H 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 6b6157b45..e9605e473 100644 --- a/cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h +++ b/cockatrice/src/interface/widgets/quick_settings/settings_popup_widget.h @@ -1,3 +1,10 @@ +/** + * @file settings_popup_widget.h + * @ingroup Widgets + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SETTINGS_POPUP_WIDGET_H #define SETTINGS_POPUP_WIDGET_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 42498766c..7b4c365c0 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,3 +1,9 @@ +/** + * @file visual_database_display_color_filter_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 5b70fbd67..7dea3fd01 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,3 +1,9 @@ +/** + * @file visual_database_display_filter_save_load_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 9d6807b95..34c6ddac2 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,3 +1,9 @@ +/** + * @file visual_database_display_main_type_filter_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 b977eb507..06f30370a 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,3 +1,9 @@ +/** + * @file visual_database_display_name_filter_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 7960ec45c..ea006c88e 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,3 +1,9 @@ +/** + * @file visual_database_display_set_filter_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 d8a3c831e..b77a1ba44 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,3 +1,9 @@ +/** + * @file visual_database_display_sub_type_filter_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 ec7bc9d5c..947afeae1 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,3 +1,9 @@ +/** + * @file visual_database_display_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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 f8aabd144..05bf43118 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,3 +1,9 @@ +/** + * @file visual_database_filter_display_widget.h + * @ingroup VisualCardDatabaseWidgets + * @brief TODO: Document this. + */ + #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_editor_sample_hand_widget.h b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_sample_hand_widget.h index 4688c6ac4..97c3bed28 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,3 +1,9 @@ +/** + * @file visual_deck_editor_sample_hand_widget.h + * @ingroup DeckEditorAnalyticsWidgets + * @brief TODO: Document this. + */ + #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.h b/cockatrice/src/interface/widgets/visual_deck_editor/visual_deck_editor_widget.h index cd5cfcd98..5453b6e22 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,3 +1,9 @@ +/** + * @file visual_deck_editor_widget.h + * @ingroup DeckEditors + * @brief TODO: Document this. + */ + #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 415d946cd..0e4a5837c 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,3 +1,9 @@ +/** + * @file deck_preview_color_identity_filter_widget.h + * @ingroup VisualDeckPreviewWidgets + * @brief TODO: Document this. + */ + #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 30564074a..86f544bd1 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,3 +1,9 @@ +/** + * @file deck_preview_deck_tags_display_widget.h + * @ingroup VisualDeckPreviewWidgets + * @brief TODO: Document this. + */ + #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 bdf4a0103..bb39943b6 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,3 +1,9 @@ +/** + * @file deck_preview_tag_addition_widget.h + * @ingroup VisualDeckPreviewWidgets + * @brief TODO: Document this. + */ + #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 cfb338dcb..e3e35fc15 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 @@ -1,3 +1,10 @@ +/** + * @file deck_preview_tag_dialog.h + * @ingroup VisualDeckPreviewWidgets + * @ingroup Dialogs + * @brief TODO: Document this. + */ + #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 ff649dd32..9b828fa3d 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,3 +1,9 @@ +/** + * @file deck_preview_tag_display_widget.h + * @ingroup VisualDeckPreviewWidgets + * @brief TODO: Document this. + */ + #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 60cd8ba44..10670d8a0 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,3 +1,9 @@ +/** + * @file deck_preview_tag_item_widget.h + * @ingroup VisualDeckPreviewWidgets + * @brief TODO: Document this. + */ + #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.h b/cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.h index a87f5aad7..152cb3e97 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,3 +1,9 @@ +/** + * @file deck_preview_widget.h + * @ingroup VisualDeckPreviewWidgets + * @brief TODO: Document this. + */ + #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 747bcf8bd..3390e016e 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,3 +1,9 @@ +/** + * @file visual_deck_storage_folder_display_widget.h + * @ingroup VisualDeckStorageWidgets + * @brief TODO: Document this. + */ + #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_quick_settings_widget.h b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_quick_settings_widget.h index 11c1d64e9..9f3225aed 100644 --- a/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_quick_settings_widget.h +++ b/cockatrice/src/interface/widgets/visual_deck_storage/visual_deck_storage_quick_settings_widget.h @@ -1,3 +1,11 @@ +/** + * @file visual_deck_storage_quick_settings_widget.h + * @ingroup VisualDeckStorageWidgets + * @brief The VDS's quick settings menu. + * Manages the widgets in the quick settings menu dropdown, as well as syncing their values with SettingsCache. + * The current values of the settings are exposed through getters and signals. + */ + #ifndef VISUAL_DECK_STORAGE_QUICK_SETTINGS_WIDGET_H #define VISUAL_DECK_STORAGE_QUICK_SETTINGS_WIDGET_H @@ -9,11 +17,6 @@ class QSpinBox; class QCheckBox; class QComboBox; -/** - * The VDS's quick settings menu. - * Manages the widgets in the quick settings menu dropdown, as well as syncing their values with SettingsCache. - * The current values of the settings are exposed through getters and signals. - */ class VisualDeckStorageQuickSettingsWidget : public SettingsButtonWidget { Q_OBJECT 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 e8b91bc5b..eff238e7e 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,3 +1,9 @@ +/** + * @file visual_deck_storage_search_widget.h + * @ingroup VisualDeckStorageWidgets + * @brief TODO: Document this. + */ + #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 1aac55d2d..1ea06aba4 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,3 +1,9 @@ +/** + * @file visual_deck_storage_sort_widget.h + * @ingroup VisualDeckStorageWidgets + * @brief TODO: Document this. + */ + #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 3198e9769..50ef855f0 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,3 +1,9 @@ +/** + * @file visual_deck_storage_tag_filter_widget.h + * @ingroup VisualDeckStorageWidgets + * @brief TODO: Document this. + */ + #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 13323c326..64741e803 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,3 +1,9 @@ +/** + * @file visual_deck_storage_widget.h + * @ingroup VisualDeckStorageWidgets + * @brief TODO: Document this. + */ + #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 11f908c6f..3b1b25638 100644 --- a/cockatrice/src/interface/window_main.h +++ b/cockatrice/src/interface/window_main.h @@ -17,6 +17,11 @@ * Free Software Foundation, Inc., * * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ +/** + * @file window_main.h + * @ingroup Core + * @brief TODO: Document this. + */ #ifndef WINDOW_H #define WINDOW_H diff --git a/cockatrice/src/main.h b/cockatrice/src/main.h index e7dccd631..1cdc4e78d 100644 --- a/cockatrice/src/main.h +++ b/cockatrice/src/main.h @@ -1,3 +1,9 @@ +/** + * @file main.h + * @ingroup Core + * @brief TODO: Document this. + */ + #ifndef MAIN_H #define MAIN_H diff --git a/cockatrice/src/server/abstract_client.h b/cockatrice/src/server/abstract_client.h index 5e4948f5e..e6a812df1 100644 --- a/cockatrice/src/server/abstract_client.h +++ b/cockatrice/src/server/abstract_client.h @@ -1,3 +1,9 @@ +/** + * @file abstract_client.h + * @ingroup Client + * @brief TODO: Document this. + */ + #ifndef ABSTRACTCLIENT_H #define ABSTRACTCLIENT_H diff --git a/cockatrice/src/server/chat_view/chat_view.h b/cockatrice/src/server/chat_view/chat_view.h index 1c7d2302d..87ff31642 100644 --- a/cockatrice/src/server/chat_view/chat_view.h +++ b/cockatrice/src/server/chat_view/chat_view.h @@ -1,3 +1,11 @@ +/** + * @file chat_view.h + * @ingroup Network + * @ingroup Lobby + * @ingroup Widgets + * @brief TODO: Document this. + */ + #ifndef CHATVIEW_H #define CHATVIEW_H diff --git a/cockatrice/src/server/game_selector.h b/cockatrice/src/server/game_selector.h index a4b8a68e2..a6cadf141 100644 --- a/cockatrice/src/server/game_selector.h +++ b/cockatrice/src/server/game_selector.h @@ -1,3 +1,9 @@ +/** + * @file game_selector.h + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef GAMESELECTOR_H #define GAMESELECTOR_H diff --git a/cockatrice/src/server/games_model.h b/cockatrice/src/server/games_model.h index 4b82a9056..155ede3f5 100644 --- a/cockatrice/src/server/games_model.h +++ b/cockatrice/src/server/games_model.h @@ -1,3 +1,10 @@ +/** + * @file games_model.h + * @ingroup Lobby + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef GAMESMODEL_H #define GAMESMODEL_H diff --git a/cockatrice/src/server/handle_public_servers.h b/cockatrice/src/server/handle_public_servers.h index 430043de1..a182a70c3 100644 --- a/cockatrice/src/server/handle_public_servers.h +++ b/cockatrice/src/server/handle_public_servers.h @@ -1,3 +1,9 @@ +/** + * @file handle_public_servers.h + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_HANDLE_PUBLIC_SERVERS_H #define COCKATRICE_HANDLE_PUBLIC_SERVERS_H diff --git a/cockatrice/src/server/local_client.h b/cockatrice/src/server/local_client.h index 145887ea8..2523e1d51 100644 --- a/cockatrice/src/server/local_client.h +++ b/cockatrice/src/server/local_client.h @@ -1,3 +1,9 @@ +/** + * @file local_client.h + * @ingroup Client + * @brief TODO: Document this. + */ + #ifndef LOCALCLIENT_H #define LOCALCLIENT_H diff --git a/cockatrice/src/server/local_server.h b/cockatrice/src/server/local_server.h index 93dbeb827..9546e3f9c 100644 --- a/cockatrice/src/server/local_server.h +++ b/cockatrice/src/server/local_server.h @@ -1,3 +1,9 @@ +/** + * @file local_server.h + * @ingroup Server + * @brief TODO: Document this. + */ + #ifndef LOCALSERVER_H #define LOCALSERVER_H diff --git a/cockatrice/src/server/local_server_interface.h b/cockatrice/src/server/local_server_interface.h index ebfc49719..5551b47a5 100644 --- a/cockatrice/src/server/local_server_interface.h +++ b/cockatrice/src/server/local_server_interface.h @@ -1,3 +1,9 @@ +/** + * @file local_server_interface.h + * @ingroup Server + * @brief TODO: Document this. + */ + #ifndef LOCALSERVERINTERFACE_H #define LOCALSERVERINTERFACE_H diff --git a/cockatrice/src/server/pending_command.h b/cockatrice/src/server/pending_command.h index d845167ac..de96adb39 100644 --- a/cockatrice/src/server/pending_command.h +++ b/cockatrice/src/server/pending_command.h @@ -1,3 +1,9 @@ +/** + * @file pending_command.h + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef PENDING_COMMAND_H #define PENDING_COMMAND_H diff --git a/cockatrice/src/server/remote/remote_client.h b/cockatrice/src/server/remote/remote_client.h index 0ab24c798..365b5b520 100644 --- a/cockatrice/src/server/remote/remote_client.h +++ b/cockatrice/src/server/remote/remote_client.h @@ -1,3 +1,9 @@ +/** + * @file remote_client.h + * @ingroup Client + * @brief TODO: Document this. + */ + #ifndef REMOTECLIENT_H #define REMOTECLIENT_H diff --git a/cockatrice/src/server/remote/remote_decklist_tree_widget.h b/cockatrice/src/server/remote/remote_decklist_tree_widget.h index f82378731..8e2bdbcf8 100644 --- a/cockatrice/src/server/remote/remote_decklist_tree_widget.h +++ b/cockatrice/src/server/remote/remote_decklist_tree_widget.h @@ -1,3 +1,10 @@ +/** + * @file remote_decklist_tree_widget.h + * @ingroup Client + * @ingroup DeckStorageWidgets + * @brief TODO: Document this. + */ + #ifndef REMOTEDECKLIST_TREEWIDGET_H #define REMOTEDECKLIST_TREEWIDGET_H 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 02082046a..b2e666fee 100644 --- a/cockatrice/src/server/remote/remote_replay_list_tree_widget.h +++ b/cockatrice/src/server/remote/remote_replay_list_tree_widget.h @@ -1,3 +1,11 @@ +/** + * @file remote_replay_list_tree_widget.h + * @ingroup DeckStorageWidgets + * @ingroup Replays + * @ingroup Client + * @brief TODO: Document this. + */ + #ifndef REMOTEREPLAYLIST_TREEWIDGET_H #define REMOTEREPLAYLIST_TREEWIDGET_H diff --git a/cockatrice/src/server/user/user_context_menu.h b/cockatrice/src/server/user/user_context_menu.h index 730cfd185..d6f48f836 100644 --- a/cockatrice/src/server/user/user_context_menu.h +++ b/cockatrice/src/server/user/user_context_menu.h @@ -1,3 +1,9 @@ +/** + * @file user_context_menu.h + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef USER_CONTEXT_MENU_H #define USER_CONTEXT_MENU_H diff --git a/cockatrice/src/server/user/user_info_box.h b/cockatrice/src/server/user/user_info_box.h index 170c27bb2..47dc70065 100644 --- a/cockatrice/src/server/user/user_info_box.h +++ b/cockatrice/src/server/user/user_info_box.h @@ -1,3 +1,10 @@ +/** + * @file user_info_box.h + * @ingroup Network + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef USERINFOBOX_H #define USERINFOBOX_H diff --git a/cockatrice/src/server/user/user_info_connection.h b/cockatrice/src/server/user/user_info_connection.h index b2abf65ac..8a9cf4007 100644 --- a/cockatrice/src/server/user/user_info_connection.h +++ b/cockatrice/src/server/user/user_info_connection.h @@ -1,3 +1,9 @@ +/** + * @file user_info_connection.h + * @ingroup Network + * @brief TODO: Document this. + */ + #ifndef USERCONNECTION_INFORMATION_H #define USERCONNECTION_INFORMATION_H diff --git a/cockatrice/src/server/user/user_list_manager.h b/cockatrice/src/server/user/user_list_manager.h index d83ec45ef..fecb8c63c 100644 --- a/cockatrice/src/server/user/user_list_manager.h +++ b/cockatrice/src/server/user/user_list_manager.h @@ -1,3 +1,10 @@ +/** + * @file user_list_manager.h + * @ingroup Network + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_USER_LIST_MANAGER_H #define COCKATRICE_USER_LIST_MANAGER_H diff --git a/cockatrice/src/server/user/user_list_proxy.h b/cockatrice/src/server/user/user_list_proxy.h index 7fa92770c..b1c20645c 100644 --- a/cockatrice/src/server/user/user_list_proxy.h +++ b/cockatrice/src/server/user/user_list_proxy.h @@ -1,3 +1,10 @@ +/** + * @file user_list_proxy.h + * @ingroup UI + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_USERLISTPROXY_H #define COCKATRICE_USERLISTPROXY_H diff --git a/cockatrice/src/server/user/user_list_widget.h b/cockatrice/src/server/user/user_list_widget.h index 561d91e77..063bac7dc 100644 --- a/cockatrice/src/server/user/user_list_widget.h +++ b/cockatrice/src/server/user/user_list_widget.h @@ -1,3 +1,10 @@ +/** + * @file user_list_widget.h + * @ingroup Network + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef USERLIST_H #define USERLIST_H diff --git a/cockatrice/src/settings/cache_settings.h b/cockatrice/src/settings/cache_settings.h index c73149d3a..52bf1bc12 100644 --- a/cockatrice/src/settings/cache_settings.h +++ b/cockatrice/src/settings/cache_settings.h @@ -1,3 +1,10 @@ +/** + * @file cache_settings.h + * @ingroup Network + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SETTINGSCACHE_H #define SETTINGSCACHE_H diff --git a/cockatrice/src/settings/card_counter_settings.h b/cockatrice/src/settings/card_counter_settings.h index bb3a9bd57..3713f8e47 100644 --- a/cockatrice/src/settings/card_counter_settings.h +++ b/cockatrice/src/settings/card_counter_settings.h @@ -1,3 +1,9 @@ +/** + * @file card_counter_settings.h + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef CARD_COUNTER_SETTINGS_H #define CARD_COUNTER_SETTINGS_H diff --git a/cockatrice/src/settings/card_database_settings.h b/cockatrice/src/settings/card_database_settings.h index 421fb60bb..0d800b664 100644 --- a/cockatrice/src/settings/card_database_settings.h +++ b/cockatrice/src/settings/card_database_settings.h @@ -1,3 +1,10 @@ +/** + * @file card_database_settings.h + * @ingroup CardDatabase + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef CARDDATABASESETTINGS_H #define CARDDATABASESETTINGS_H diff --git a/cockatrice/src/settings/card_override_settings.h b/cockatrice/src/settings/card_override_settings.h index 520d9f65f..ba4ef7095 100644 --- a/cockatrice/src/settings/card_override_settings.h +++ b/cockatrice/src/settings/card_override_settings.h @@ -1,3 +1,9 @@ +/** + * @file card_override_settings.h + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_CARD_OVERRIDE_SETTINGS_H #define COCKATRICE_CARD_OVERRIDE_SETTINGS_H diff --git a/cockatrice/src/settings/debug_settings.h b/cockatrice/src/settings/debug_settings.h index 89ea33e4e..596708f60 100644 --- a/cockatrice/src/settings/debug_settings.h +++ b/cockatrice/src/settings/debug_settings.h @@ -1,3 +1,10 @@ +/** + * @file debug_settings.h + * @ingroup Core + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef DEBUG_SETTINGS_H #define DEBUG_SETTINGS_H #include "settings_manager.h" diff --git a/cockatrice/src/settings/download_settings.h b/cockatrice/src/settings/download_settings.h index a961199b3..6e212954f 100644 --- a/cockatrice/src/settings/download_settings.h +++ b/cockatrice/src/settings/download_settings.h @@ -1,3 +1,10 @@ +/** + * @file download_settings.h + * @ingroup Network + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_DOWNLOADSETTINGS_H #define COCKATRICE_DOWNLOADSETTINGS_H diff --git a/cockatrice/src/settings/game_filters_settings.h b/cockatrice/src/settings/game_filters_settings.h index a243c74e9..b533c5045 100644 --- a/cockatrice/src/settings/game_filters_settings.h +++ b/cockatrice/src/settings/game_filters_settings.h @@ -1,3 +1,10 @@ +/** + * @file game_filters_settings.h + * @ingroup Lobby + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef GAMEFILTERSSETTINGS_H #define GAMEFILTERSSETTINGS_H diff --git a/cockatrice/src/settings/layouts_settings.h b/cockatrice/src/settings/layouts_settings.h index 0464bec01..89fec2577 100644 --- a/cockatrice/src/settings/layouts_settings.h +++ b/cockatrice/src/settings/layouts_settings.h @@ -1,3 +1,9 @@ +/** + * @file layouts_settings.h + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef LAYOUTSSETTINGS_H #define LAYOUTSSETTINGS_H diff --git a/cockatrice/src/settings/message_settings.h b/cockatrice/src/settings/message_settings.h index 6d65ce6e8..b37e812bb 100644 --- a/cockatrice/src/settings/message_settings.h +++ b/cockatrice/src/settings/message_settings.h @@ -1,3 +1,10 @@ +/** + * @file message_settings.h + * @ingroup Network + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef MESSAGESETTINGS_H #define MESSAGESETTINGS_H diff --git a/cockatrice/src/settings/recents_settings.h b/cockatrice/src/settings/recents_settings.h index 6e91cd2f0..5650af349 100644 --- a/cockatrice/src/settings/recents_settings.h +++ b/cockatrice/src/settings/recents_settings.h @@ -1,3 +1,10 @@ +/** + * @file recents_settings.h + * @ingroup DeckStorage + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef RECENTS_SETTINGS_H #define RECENTS_SETTINGS_H diff --git a/cockatrice/src/settings/servers_settings.h b/cockatrice/src/settings/servers_settings.h index 9bf5c47d7..19f648169 100644 --- a/cockatrice/src/settings/servers_settings.h +++ b/cockatrice/src/settings/servers_settings.h @@ -1,3 +1,10 @@ +/** + * @file servers_settings.h + * @ingroup Network + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SERVERSSETTINGS_H #define SERVERSSETTINGS_H diff --git a/cockatrice/src/settings/settings_manager.h b/cockatrice/src/settings/settings_manager.h index cd1242962..1a24ecb28 100644 --- a/cockatrice/src/settings/settings_manager.h +++ b/cockatrice/src/settings/settings_manager.h @@ -1,3 +1,9 @@ +/** + * @file settings_manager.h + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SETTINGSMANAGER_H #define SETTINGSMANAGER_H diff --git a/cockatrice/src/settings/shortcut_treeview.h b/cockatrice/src/settings/shortcut_treeview.h index dc96d0360..07436536a 100644 --- a/cockatrice/src/settings/shortcut_treeview.h +++ b/cockatrice/src/settings/shortcut_treeview.h @@ -1,3 +1,9 @@ +/** + * @file shortcut_treeview.h + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SHORTCUT_TREEVIEW_H #define SHORTCUT_TREEVIEW_H diff --git a/cockatrice/src/settings/shortcuts_settings.h b/cockatrice/src/settings/shortcuts_settings.h index 3f7b94148..a25379139 100644 --- a/cockatrice/src/settings/shortcuts_settings.h +++ b/cockatrice/src/settings/shortcuts_settings.h @@ -1,3 +1,9 @@ +/** + * @file shortcuts_settings.h + * @ingroup Settings + * @brief TODO: Document this. + */ + #ifndef SHORTCUTSSETTINGS_H #define SHORTCUTSSETTINGS_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/archidekt_links/edhrec_api_response_archidekt_links.h b/cockatrice/src/tabs/api/edhrec/api_response/archidekt_links/edhrec_api_response_archidekt_links.h index b47101e78..236e36305 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/archidekt_links/edhrec_api_response_archidekt_links.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/archidekt_links/edhrec_api_response_archidekt_links.h @@ -6,7 +6,11 @@ #include #include -// Represents a single Archidekt entry +/** + * @class EdhrecApiResponseArchidektLink + * @ingroup ApiResponses + * @brief Represents a single Archidekt entry + */ class EdhrecApiResponseArchidektLink { public: @@ -19,7 +23,11 @@ public: void debugPrint() const; }; -// Represents the Archidekt section as a list of entries +/** + * @class EdhrecCommanderApiResponseArchidektLinks + * @ingroup ApiResponses + * @brief Represents the Archidekt section as a list of entries + */ class EdhrecCommanderApiResponseArchidektLinks { public: diff --git a/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_average_deck_api_response.h b/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_average_deck_api_response.h index 2d330e3e8..1a60b95d0 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_average_deck_api_response.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_average_deck_api_response.h @@ -10,7 +10,11 @@ #include #include -// Represents the main structure of the JSON +/** + * @class EdhrecAverageDeckApiResponse + * @ingroup ApiResponses + * @brief Represents the main structure of the JSON + */ class EdhrecAverageDeckApiResponse { public: diff --git a/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h b/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h index fe8be7f6c..952162a4e 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/average_deck/edhrec_deck_api_response.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_deck_api_response.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef EDHREC_DECK_API_RESPONSE_H #define EDHREC_DECK_API_RESPONSE_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h b/cockatrice/src/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h index 32e017a92..7011d3aaf 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/card_prices/edhrec_api_response_card_prices.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_prices.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H #define EDHREC_COMMANDER_API_RESPONSE_CARD_PRICES_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h index 94650785f..d23c4f27d 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_container.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_container.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef CONTAINER_ENTRY_H #define CONTAINER_ENTRY_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h index 9f75aac72..86d78c5e3 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_details.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_details.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef CARD_VIEW_H #define CARD_VIEW_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h index 9fcacfffe..068945a30 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_api_response_card_list.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_list.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef CARD_LIST_H #define CARD_LIST_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h index 7b754c9b2..64b5970da 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/cards/edhrec_commander_api_response_commander_details.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_commander_api_response_commander_details.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H #define EDHREC_COMMANDER_API_RESPONSE_COMMANDER_DETAILS_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response.h b/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response.h index e859184d2..9e6629142 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response.h @@ -9,7 +9,11 @@ #include #include -// Represents the main structure of the JSON +/** + * @class EdhrecCommanderApiResponse + * @ingroup ApiResponses + * @brief Represents the main structure of the JSON + */ class EdhrecCommanderApiResponse { public: diff --git a/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response_average_deck_statistics.h b/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response_average_deck_statistics.h index 1dd01abe2..5d9980220 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response_average_deck_statistics.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/commander/edhrec_commander_api_response_average_deck_statistics.h @@ -3,7 +3,11 @@ #include -// Represents the typical deck statistics (collapsed section) +/** + * @struct EdhrecCommanderApiResponseAverageDeckStatistics + * @ingroup ApiResponses + * @brief Represents the typical deck statistics (collapsed section) + */ struct EdhrecCommanderApiResponseAverageDeckStatistics { int creature = 0; diff --git a/cockatrice/src/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h b/cockatrice/src/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h index 569c31894..a9a6316e3 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/top_cards/edhrec_top_cards_api_response.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_top_cards_api_response.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef EDHREC_TOP_CARDS_API_RESPONSE_H #define EDHREC_TOP_CARDS_API_RESPONSE_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h b/cockatrice/src/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h index 526611eb7..1e99e90f0 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/top_commanders/edhrec_top_commanders_api_response.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_top_commanders_api_response.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_H #define EDHREC_TOP_COMMANDERS_API_RESPONSE_H diff --git a/cockatrice/src/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h b/cockatrice/src/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h index f31d03a8e..382e2899e 100644 --- a/cockatrice/src/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h +++ b/cockatrice/src/tabs/api/edhrec/api_response/top_tags/edhrec_top_tags_api_response.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_top_tags_api_response.h + * @ingroup ApiResponses + * @brief TODO: Document this. + */ + #ifndef EDHREC_TOP_TAGS_API_RESPONSE_H #define EDHREC_TOP_TAGS_API_RESPONSE_H diff --git a/cockatrice/src/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h index 8dae375fe..80d32a394 100644 --- a/cockatrice/src/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/card_prices/edhrec_api_response_card_prices_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_prices_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H #define EDHREC_API_RESPONSE_CARD_PRICES_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h index 1182bcf26..ae0777613 100644 --- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_details_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_details_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #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/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h index db55b2b41..cc5039c53 100644 --- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_inclusion_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_inclusion_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H #define EDHREC_API_RESPONSE_CARD_INCLUSION_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h index 1f7e66887..bb278013f 100644 --- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_list_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_list_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #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/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h index 8877b4510..e6a8c02fe 100644 --- a/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/cards/edhrec_api_response_card_synergy_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_card_synergy_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H #define EDHREC_API_RESPONSE_CARD_SYNERGY_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h index dbd396b0f..3ab433a41 100644 --- a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_api_response_commander_details_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_api_response_commander_details_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #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/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h index 172b64e32..1678e1380 100644 --- a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_commander_api_response_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h index 16f601b9b..b97e095f7 100644 --- a/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/commander/edhrec_commander_api_response_navigation_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_commander_api_response_navigation_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H #define EDHREC_COMMANDER_API_RESPONSE_NAVIGATION_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h index 4b7a34d6a..e2748bf10 100644 --- a/cockatrice/src/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/top_cards/edhrec_top_cards_api_response_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_top_cards_api_response_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_TOP_CARDS_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h index e8774d38b..766518c02 100644 --- a/cockatrice/src/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/top_commander/edhrec_top_commanders_api_response_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_top_commanders_api_response_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_TOP_COMMANDERS_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h b/cockatrice/src/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h index d67875058..84b401eb7 100644 --- a/cockatrice/src/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h +++ b/cockatrice/src/tabs/api/edhrec/display/top_tags/edhrec_top_tags_api_response_display_widget.h @@ -1,3 +1,9 @@ +/** + * @file edhrec_top_tags_api_response_display_widget.h + * @ingroup ApiResponseDisplayWidgets + * @brief TODO: Document this. + */ + #ifndef EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H #define EDHREC_TOP_TAGS_API_RESPONSE_DISPLAY_WIDGET_H diff --git a/cockatrice/src/tabs/api/edhrec/tab_edhrec.h b/cockatrice/src/tabs/api/edhrec/tab_edhrec.h index 517a04051..ac3d7ea11 100644 --- a/cockatrice/src/tabs/api/edhrec/tab_edhrec.h +++ b/cockatrice/src/tabs/api/edhrec/tab_edhrec.h @@ -1,3 +1,9 @@ +/** + * @file tab_edhrec.h + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_EDHREC_H #define TAB_EDHREC_H diff --git a/cockatrice/src/tabs/api/edhrec/tab_edhrec_main.h b/cockatrice/src/tabs/api/edhrec/tab_edhrec_main.h index a7e2ab2f4..d9b96ac76 100644 --- a/cockatrice/src/tabs/api/edhrec/tab_edhrec_main.h +++ b/cockatrice/src/tabs/api/edhrec/tab_edhrec_main.h @@ -1,3 +1,9 @@ +/** + * @file tab_edhrec_main.h + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_EDHREC_MAIN_H #define TAB_EDHREC_MAIN_H diff --git a/cockatrice/src/tabs/tab.h b/cockatrice/src/tabs/tab.h index fc97585c3..a431aac75 100644 --- a/cockatrice/src/tabs/tab.h +++ b/cockatrice/src/tabs/tab.h @@ -1,3 +1,9 @@ +/** + * @file tab.h + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_H #define TAB_H diff --git a/cockatrice/src/tabs/tab_account.h b/cockatrice/src/tabs/tab_account.h index 5824a7527..e72d5df4f 100644 --- a/cockatrice/src/tabs/tab_account.h +++ b/cockatrice/src/tabs/tab_account.h @@ -1,3 +1,9 @@ +/** + * @file tab_account.h + * @ingroup NetworkingTabs + * @brief TODO: Document this. + */ + #ifndef TAB_ACCOUNT_H #define TAB_ACCOUNT_H diff --git a/cockatrice/src/tabs/tab_admin.h b/cockatrice/src/tabs/tab_admin.h index e219aa627..22ba9280d 100644 --- a/cockatrice/src/tabs/tab_admin.h +++ b/cockatrice/src/tabs/tab_admin.h @@ -1,3 +1,9 @@ +/** + * @file tab_admin.h + * @ingroup NetworkingTabs + * @brief TODO: Document this. + */ + #ifndef TAB_ADMIN_H #define TAB_ADMIN_H diff --git a/cockatrice/src/tabs/tab_deck_storage.h b/cockatrice/src/tabs/tab_deck_storage.h index 6e9deb320..ae52bba85 100644 --- a/cockatrice/src/tabs/tab_deck_storage.h +++ b/cockatrice/src/tabs/tab_deck_storage.h @@ -1,3 +1,10 @@ +/** + * @file tab_deck_storage.h + * @ingroup DeckStorageWidgets + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_DECK_STORAGE_H #define TAB_DECK_STORAGE_H diff --git a/cockatrice/src/tabs/tab_game.h b/cockatrice/src/tabs/tab_game.h index a0aeb8138..eee5769ab 100644 --- a/cockatrice/src/tabs/tab_game.h +++ b/cockatrice/src/tabs/tab_game.h @@ -1,3 +1,11 @@ +/** + * @file tab_game.h + * @ingroup Tabs + * @ingroup GameWidgets + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef TAB_GAME_H #define TAB_GAME_H diff --git a/cockatrice/src/tabs/tab_home.h b/cockatrice/src/tabs/tab_home.h index d2cacb65d..26a372884 100644 --- a/cockatrice/src/tabs/tab_home.h +++ b/cockatrice/src/tabs/tab_home.h @@ -1,3 +1,9 @@ +/** + * @file tab_home.h + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_HOME_H #define TAB_HOME_H diff --git a/cockatrice/src/tabs/tab_logs.h b/cockatrice/src/tabs/tab_logs.h index 5694a24c7..f548473e1 100644 --- a/cockatrice/src/tabs/tab_logs.h +++ b/cockatrice/src/tabs/tab_logs.h @@ -1,3 +1,9 @@ +/** + * @file tab_logs.h + * @ingroup NetworkingTabs + * @brief TODO: Document this. + */ + #ifndef TAB_LOG_H #define TAB_LOG_H diff --git a/cockatrice/src/tabs/tab_message.h b/cockatrice/src/tabs/tab_message.h index 659d0b804..ca7306622 100644 --- a/cockatrice/src/tabs/tab_message.h +++ b/cockatrice/src/tabs/tab_message.h @@ -1,3 +1,9 @@ +/** + * @file tab_message.h + * @ingroup NetworkingTabs + * @brief TODO: Document this. + */ + #ifndef TAB_MESSAGE_H #define TAB_MESSAGE_H diff --git a/cockatrice/src/tabs/tab_replays.h b/cockatrice/src/tabs/tab_replays.h index b3a1d5fad..7a29abe1f 100644 --- a/cockatrice/src/tabs/tab_replays.h +++ b/cockatrice/src/tabs/tab_replays.h @@ -1,3 +1,10 @@ +/** + * @file tab_replays.h + * @ingroup Replays + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_REPLAYS_H #define TAB_REPLAYS_H diff --git a/cockatrice/src/tabs/tab_room.h b/cockatrice/src/tabs/tab_room.h index 040130d10..2c20e3273 100644 --- a/cockatrice/src/tabs/tab_room.h +++ b/cockatrice/src/tabs/tab_room.h @@ -1,3 +1,10 @@ +/** + * @file tab_room.h + * @ingroup NetworkingTabs + * @ingroup Lobby + * @brief TODO: Document this. + */ + #ifndef TAB_ROOM_H #define TAB_ROOM_H diff --git a/cockatrice/src/tabs/tab_server.h b/cockatrice/src/tabs/tab_server.h index 51df54397..c7d11efbc 100644 --- a/cockatrice/src/tabs/tab_server.h +++ b/cockatrice/src/tabs/tab_server.h @@ -1,3 +1,9 @@ +/** + * @file tab_server.h + * @ingroup NetworkingTabs + * @brief TODO: Document this. + */ + #ifndef TAB_SERVER_H #define TAB_SERVER_H diff --git a/cockatrice/src/tabs/tab_supervisor.h b/cockatrice/src/tabs/tab_supervisor.h index 165c3489b..014d99825 100644 --- a/cockatrice/src/tabs/tab_supervisor.h +++ b/cockatrice/src/tabs/tab_supervisor.h @@ -1,3 +1,10 @@ +/** + * @file tab_supervisor.h + * @ingroup Core + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_SUPERVISOR_H #define TAB_SUPERVISOR_H diff --git a/cockatrice/src/tabs/tab_visual_database_display.h b/cockatrice/src/tabs/tab_visual_database_display.h index 689f5269c..b9e1a9387 100644 --- a/cockatrice/src/tabs/tab_visual_database_display.h +++ b/cockatrice/src/tabs/tab_visual_database_display.h @@ -1,3 +1,9 @@ +/** + * @file tab_visual_database_display.h + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_VISUAL_DATABASE_DISPLAY_H #define TAB_VISUAL_DATABASE_DISPLAY_H diff --git a/cockatrice/src/tabs/visual_deck_storage/tab_deck_storage_visual.h b/cockatrice/src/tabs/visual_deck_storage/tab_deck_storage_visual.h index 10cd3b0cb..f26bce863 100644 --- a/cockatrice/src/tabs/visual_deck_storage/tab_deck_storage_visual.h +++ b/cockatrice/src/tabs/visual_deck_storage/tab_deck_storage_visual.h @@ -1,3 +1,9 @@ +/** + * @file tab_deck_storage_visual.h + * @ingroup Tabs + * @brief TODO: Document this. + */ + #ifndef TAB_DECK_STORAGE_VISUAL_H #define TAB_DECK_STORAGE_VISUAL_H diff --git a/cockatrice/src/utility/card_info_comparator.h b/cockatrice/src/utility/card_info_comparator.h index 18535c85a..8b02afaf3 100644 --- a/cockatrice/src/utility/card_info_comparator.h +++ b/cockatrice/src/utility/card_info_comparator.h @@ -1,3 +1,9 @@ +/** + * @file card_info_comparator.h + * @ingroup Cards + * @brief TODO: Document this. + */ + #ifndef CARD_INFO_COMPARATOR_H #define CARD_INFO_COMPARATOR_H diff --git a/cockatrice/src/utility/card_set_comparator.h b/cockatrice/src/utility/card_set_comparator.h index d68376cca..4089cf42b 100644 --- a/cockatrice/src/utility/card_set_comparator.h +++ b/cockatrice/src/utility/card_set_comparator.h @@ -1,3 +1,9 @@ +/** + * @file card_set_comparator.h + * @ingroup Cards + * @brief TODO: Document this. + */ + #ifndef SET_PRIORITY_COMPARATOR_H #define SET_PRIORITY_COMPARATOR_H diff --git a/cockatrice/src/utility/deck_list_sort_filter_proxy_model.h b/cockatrice/src/utility/deck_list_sort_filter_proxy_model.h index d21907c84..af352a56b 100644 --- a/cockatrice/src/utility/deck_list_sort_filter_proxy_model.h +++ b/cockatrice/src/utility/deck_list_sort_filter_proxy_model.h @@ -1,3 +1,9 @@ +/** + * @file deck_list_sort_filter_proxy_model.h + * @ingroup DeckEditorCardGroupWidgets + * @brief TODO: Document this. + */ + #ifndef COCKATRICE_DECK_LIST_SORT_FILTER_PROXY_MODEL_H #define COCKATRICE_DECK_LIST_SORT_FILTER_PROXY_MODEL_H diff --git a/cockatrice/src/utility/key_signals.h b/cockatrice/src/utility/key_signals.h index 32e656c76..3404dca9e 100644 --- a/cockatrice/src/utility/key_signals.h +++ b/cockatrice/src/utility/key_signals.h @@ -1,3 +1,10 @@ +/** + * @file key_signals.h + * @ingroup Core + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef KEYSIGNALS_H #define KEYSIGNALS_H diff --git a/cockatrice/src/utility/levenshtein.h b/cockatrice/src/utility/levenshtein.h index b9b05a13c..e83235470 100644 --- a/cockatrice/src/utility/levenshtein.h +++ b/cockatrice/src/utility/levenshtein.h @@ -1,3 +1,9 @@ +/** + * @file levenshtein.h + * @ingroup Core + * @brief TODO: Document this. + */ + #ifndef LEVENSHTEIN_H #define LEVENSHTEIN_H diff --git a/cockatrice/src/utility/logger.h b/cockatrice/src/utility/logger.h index b90644b36..59244e226 100644 --- a/cockatrice/src/utility/logger.h +++ b/cockatrice/src/utility/logger.h @@ -1,3 +1,9 @@ +/** + * @file logger.h + * @ingroup Core + * @brief TODO: Document this. + */ + #ifndef LOGGER_H #define LOGGER_H diff --git a/cockatrice/src/utility/sequence_edit.h b/cockatrice/src/utility/sequence_edit.h index e2ce6845e..a146aa752 100644 --- a/cockatrice/src/utility/sequence_edit.h +++ b/cockatrice/src/utility/sequence_edit.h @@ -1,3 +1,9 @@ +/** + * @file sequence_edit.h + * @ingroup UI + * @brief TODO: Document this. + */ + #ifndef SEQUENCEEDIT_H #define SEQUENCEEDIT_H diff --git a/common/abstract_deck_list_card_node.h b/common/abstract_deck_list_card_node.h index 82d334db8..19bebf5f9 100644 --- a/common/abstract_deck_list_card_node.h +++ b/common/abstract_deck_list_card_node.h @@ -15,6 +15,7 @@ /** * @class AbstractDecklistCardNode + * @ingroup DeckModels * @brief Abstract base class for all deck list nodes that represent * actual card entries. * diff --git a/common/abstract_deck_list_node.h b/common/abstract_deck_list_node.h index 6dcc2c7d6..3a82cfab9 100644 --- a/common/abstract_deck_list_node.h +++ b/common/abstract_deck_list_node.h @@ -22,6 +22,7 @@ /** * @enum DeckSortMethod + * @ingroup DeckModels * @brief Defines the different sort strategies a node may use * to order its children. * @@ -43,6 +44,7 @@ class InnerDecklistNode; /** * @class AbstractDecklistNode + * @ingroup DeckModels * @brief Base class for all nodes in the deck list tree. * * This class defines the common interface for every node in the diff --git a/common/deck_list.h b/common/deck_list.h index 0596b38fd..2a70ea4b1 100644 --- a/common/deck_list.h +++ b/common/deck_list.h @@ -28,6 +28,7 @@ class InnerDecklistNode; /** * @class SideboardPlan + * @ingroup Decks * @brief Represents a predefined sideboarding strategy for a deck. * * Sideboard plans store a named list of card movements that should be applied @@ -88,6 +89,7 @@ public: /** * @class DeckList + * @ingroup Decks * @brief Represents a complete deck, including metadata, zones, cards, * and sideboard plans. * diff --git a/common/deck_list_card_node.h b/common/deck_list_card_node.h index 3ccb8e062..84a396daf 100644 --- a/common/deck_list_card_node.h +++ b/common/deck_list_card_node.h @@ -17,6 +17,7 @@ /** * @class DecklistCardNode + * @ingroup DeckModels * @brief Concrete node type representing an actual card entry in the deck. * * This class extends AbstractDecklistCardNode to hold all information diff --git a/doc/doxygen-groups/doc_groups.dox b/doc/doxygen-groups/doc_groups.dox new file mode 100644 index 000000000..783eb04d8 --- /dev/null +++ b/doc/doxygen-groups/doc_groups.dox @@ -0,0 +1,553 @@ +/** @file doc_groups.dox + * @brief Doxygen group definitions for Cockatrice. + * + * This file defines the documentation groups and hierarchy used + * throughout the Cockatrice codebase. Reference these groups with @ingroup. + */ + +/* ------------------------------------------------------------------ */ +/* Core */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Core Core + * @brief Core utilities, shared types, and infrastructure. + * + * Provides the foundational building blocks used throughout Cockatrice. + * This includes logging facilities, settings management, serialization helpers, + * common enumerations, and general-purpose utility classes and functions. + */ + +/* ------------------------------------------------------------------ */ +/* Networking */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Network Networking + * @brief Networking components for client/server communication. + * + * Contains all systems related to communication between client and server. + * This includes lobby and room management, server interaction logic, and + * message handling infrastructure based on protobuf. + */ + +/** + * @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 ApiResponseDisplayWidgets API Response Display Widgets + * @ingroup ApiResponses + * @brief Qt widgets for displaying API responses. + * + * Provides user interface components that render and present API response + * data to the user in a structured and interactive way. + */ + +/** + * @defgroup Messages Protocol Messages + * @ingroup Network + * @brief Protocol message definitions and handlers. + * + * Contains the generated protobuf messages and supporting code used + * to encode, decode, and process communication between client and server. + */ + +/** + * @defgroup Client Client + * @ingroup Network + * @brief The Cockatrice client application. + * + * Handles all client-side communication with the server. + */ + +/** + * @defgroup ClientUpdates Client Updates + * @ingroup Client + * @brief Client updates. + */ + +/** + * @defgroup Server Server + * @ingroup Network + * @brief The Cockatrice server application. + * + * Provides the authoritative game backend, handling authentication, + * lobbies, game rooms, and relaying state between connected clients. + */ + +/** + * @defgroup Lobby Lobby & Rooms + * @ingroup Network + * @brief Multiplayer lobby and room management. + * + * Manages creation and interaction of Game lobbies and room state synchronization with the server. + */ + +/* ------------------------------------------------------------------ */ +/* Game */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Game Game + * @brief Core game framework. + * + * Responsible for the main Game loop, GameState management, + * CardZone handling, and resolution of in-game actions. + */ + +/** + * @defgroup GameUi User Interface + * @ingroup Game + * @brief Graphical components for in-game interaction. + * + * Provides Qt-based widgets, dialogs, and menus used during a Game, + * supporting both visual presentation and interaction logic. + */ + +/** + * @defgroup GameLobby Lobby + * @ingroup GameUi + * @brief User interface for the multiplayer lobby. + * + * Contains widgets, dialogs, and models used to interact with the + * lobby within the Game UI layer. + */ + +/** + * @defgroup GameWidgets Game Widgets + * @ingroup GameUi + * @brief Widgets specific to the in-game interface. + * + * Provides reusable visual components that represent elements + * of the ongoing Game, such as a PlayerGraphicsItem or CardZone views. + */ + +/** + * @defgroup GameDialogs Dialogs + * @ingroup GameUi + * @brief In-game dialogs. + * + * Modal and non-modal dialogs for Player interaction during a Game, + * including prompts, confirmations, and detailed views. + */ + +/** + * @defgroup GameMenus Menus + * @ingroup GameUi + * @brief In-game menu structures. + * + * Provides menu bars, context menus, and hierarchical options + * available to the Player during a Game session. + */ + +/** + * @defgroup GameMenusPlayers Player + * @ingroup GameMenus + * @brief Menus specific to player actions. + * + * Defines context menus and options relating to Player state and PlayerActions. + */ + +/** + * @defgroup GameMenusZones Zones + * @ingroup GameMenus + * @brief Menus for interacting with zones. + * + * Provides contextual options for a CardZone such as the hand, + * library, graveyard, and battlefield. + */ + +/** + * @defgroup GameMenusCards Cards + * @ingroup GameMenus + * @brief Menus for card interactions. + * + * Defines right-click menus and contextual options available + * when interacting with an individual CardItem. + */ + +/** + * @defgroup GameGraphics Graphics + * @ingroup GameUi + * @brief Visual graphics for game elements. + * + * Provides rendering and layout for core game objects such as a + * Player, CardZone, or CardItem in the interface. + */ + +/** + * @defgroup GameGraphicsPlayers Players + * @ingroup GameGraphics + * @brief Player-specific graphical elements. + * + * Defines visual representations of a Player, their states, + * and associated on-screen information. + */ + +/** + * @defgroup GameGraphicsZones Zones + * @ingroup GameGraphics + * @brief Graphical representations of zones. + * + * Provides layout, visuals, and animations for a CardZone like the hand, + * library, battlefield, and graveyard. + */ + +/** + * @defgroup GameGraphicsCards Cards + * @ingroup GameGraphics + * @brief Graphical representation of cards. + * + * Manages the visual look and behavior of a CardItem when displayed + * in the game interface. + */ + +/** + * @defgroup GameLogic Logic + * @ingroup Game + * @brief Game logic and rules framework. + * + * Implements resolution of actions and logical + * state management for an ongoing Game. + */ + +/** + * @defgroup GameLogicPlayers Players + * @ingroup GameLogic + * @brief Logic related to player state. + * + * Handles Player attributes, PlayerActions, resources, and their impact + * on GameState. + */ + +/** + * @defgroup GameLogicZones Zones + * @ingroup GameLogic + * @brief Logical handling of CardZones during a Game. + * + * Defines the rules and behaviors of zones such as the hand, + * battlefield, library, and graveyard. + */ + +/** + * @defgroup GameLogicActions Actions + * @ingroup GameLogic + * @brief Actions, events, and their resolution. + * + * Encapsulates how actions are created, queued, and resolved, + * including event handling and triggered effects. + */ + +/* ------------------------------------------------------------------ */ +/* Decks */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Decks Deck Management + * @brief DeckList handling, persistence, and tooling. + * + * Covers the lifecycle of decks: loading, saving, editing, import/export, + * and long-term persistence, including both textual and visual editors. + */ + +/** + * @defgroup DeckModels Deck Models + * @ingroup Decks + * @brief Qt Models relating to DeckList. + */ + +/** + * @defgroup DeckEditors Deck Editors + * @ingroup Decks + * @brief Editors for creating and modifying a DeckList. + * + * Provides visual and textual editors for building, modifying, + * and analyzing decks. Includes support for card search, + * sorting, and filtering of deck contents. + */ + +/** + * @defgroup DeckEditorWidgets Deck Editor Widgets + * @ingroup DeckEditors + * @brief Supporting widgets for deck editors. + * + * Contains specialized UI components that extend deck editors with + * interactive functionality, data views, and user interaction tools. + */ + +/** + * @defgroup DeckEditorAnalyticsWidgets Deck Editor Analytics Widgets + * @ingroup DeckEditorWidgets + * @brief Widgets for analyzing a DeckList. + * + * Provides visualization and statistical tools for analyzing decks. + */ + +/** + * @defgroup DeckEditorCardGroupWidgets Card Group Display Widgets + * @ingroup DeckEditorWidgets + * @brief Widgets for displaying groups of cards. + * + * Provides interactive views that organize and display cards in groups, + * enabling filtering, sorting, and direct manipulation of deck sections. + */ + +/** + * @defgroup PrintingWidgets Printing Widgets + * @ingroup DeckEditorWidgets + * @brief Widgets for handling PrintingInfo of cards in a DeckList. + * + * Manages the display and editing of card printing information within a DeckList, + * including editions, variations, and preferences. + */ + +/** + * @defgroup DeckStorage Deck Storage + * @ingroup Decks + * @brief Systems for storing a DeckList. + * + * Handles the persistence of a DeckList, providing file-based storage, + * metadata tracking, and tagging functionality. + */ + +/** + * @defgroup DeckStorageWidgets Deck Storage Widgets + * @ingroup DeckStorage + * @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 VisualDeckStorageWidgets Visual Deck Storage Widgets + * @ingroup DeckStorageWidgets + * @brief Visual widgets for DeckList storage. + * + * Offers graphical interfaces for browsing and interacting with a stored + * DeckList and tags, focusing on a more visual browsing experience. + */ + +/** + * @defgroup VisualDeckPreviewWidgets Visual Deck Preview Widgets + * @ingroup VisualDeckStorageWidgets + * @brief Widgets for visually previewing a DeckList. + * + * Provides visual previews of a DeckList, allowing users + * to inspect the deck name, color identity, and banner card at a glance. + */ + +/** + * @defgroup ImportExport Import/Export + * @ingroup DeckStorage + * @brief DeckList import, export, and conversion. + * + * Supports importing and exporting a DeckList across formats, including + * text, Cockatrice-native formats, and third-party platforms. + */ + +/** + * @defgroup Parsing Parsing + * @ingroup DeckStorage + * @brief Deck parsing and external API integration. + * + * Contains parsers for deck URLs and APIs (e.g., TappedOut, Archidekt, + * Moxfield, Deckstats), allowing seamless import and synchronization. + */ + +/* ------------------------------------------------------------------ */ +/* Cards */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Cards Cards + * @brief Representation of individual cards and their state. + * + * Defines card objects, attributes, metadata, and runtime state within + * both the database and the game engine. + */ + +/** + * @defgroup CardSets Card Sets + * @ingroup Cards + * @brief Card sets. + */ + +/** + * @defgroup CardPrintings Card Printings + * @ingroup Cards + * @brief Information about specific printings of cards. + */ + +/** + * @defgroup CardWidgets Card Widgets + * @ingroup Cards + * @brief Widgets for card display and interaction. + * + * Provides UI components that render individual cards, handle + * interactions, and display card details within the application. + */ + +/** + * @defgroup CardExtraInfoWidgets Card Extra Info Widgets + * @ingroup CardWidgets + * @brief Widgets for extended card information. + * + * Displays additional data associated with cards or data in a different form. + */ + +/** + * @defgroup CardDatabase Card Database + * @ingroup Cards + * @brief Core card database and loaders. + * + * Provides the underlying data models for cards, including loading, + * parsing, and managing the complete card database used in the application. + */ + +/** + * @defgroup CardDatabaseModels Models + * @ingroup CardDatabase + * @brief Qt models for card database access. + * + * Supplies Qt model abstractions for presenting card data in views, + * supporting filtering, sorting, and data binding to widgets. + */ + +/** + * @defgroup CardDatabaseModelFilters Filters + * @ingroup CardDatabaseModels + * @brief Filters for card database models. + * + * Provides reusable filtering components for Qt models, enabling + * refined queries and customized card data views. + */ + +/** + * @defgroup CardDatabaseParsers Parsers + * @ingroup CardDatabase + * @brief Parsers for card data. + * + * Implements parsers for card database structures, handling the + * transformation of raw data into structured objects and models. + */ + +/** + * @defgroup CardDatabaseWidgets Card Database Widgets + * @ingroup CardDatabase + * @brief Widgets for browsing and selecting cards. + * + * Provides UI components for interacting with the card database, + * including search, filtering, and browsing in tabular or list views. + */ + +/** + * @defgroup VisualCardDatabaseWidgets Visual Card Database Widgets + * @ingroup CardDatabaseWidgets + * @brief VisualDatabaseDisplayWidget and related helper classes. + * + * Enhances card browsing with graphical interfaces, offering + * image-based and grid-based views for selecting cards. + */ + +/* ------------------------------------------------------------------ */ +/* UI */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup UI User Interface + * @brief Graphical interface components built with Qt. + * + * Includes high-level widgets, dialogs, models, and editors that form + * the interactive frontend of Cockatrice. + */ + +/** + * @defgroup Widgets Widgets + * @ingroup UI + * @brief General-purpose Qt widgets. + * + * A collection of reusable widgets used throughout the application, + * such as CardInfoPictureFoilWidget, DeckAnalyticsWidget, and others. + */ + +/** + * @defgroup Tabs Tabs + * @ingroup Widgets + * @brief Tabbed UI components. + * + * Provides tab-based interfaces for organizing and navigating + * between multiple views in the application. + */ + +/** + * @defgroup DeckEditorTabs Deck Editor Tabs + * @ingroup Tabs + * @ingroup DeckEditors + * @brief Tabs for the Deck Editors + */ + +/** + * @defgroup NetworkingTabs Networking Tabs + * @ingroup Tabs + * @ingroup Network + */ + +/** + * @defgroup Dialogs Dialogs + * @ingroup UI + * @brief Application dialogs. + * + * Includes dialogs for card prices, deck import/export, + * settings, and other modal user interactions. + */ + +/** + * @defgroup NetworkDialogs Networking Dialogs + * @ingroup Dialogs + * @ingroup Network + * @brief Dialogs related to interacting with a remote server. + */ + +/* ------------------------------------------------------------------ */ +/* Replay */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Replay Replays + * @brief Replay recording and playback. + * + * Provides mechanisms for capturing game sessions, storing them in + * replay files, and replaying them for review or analysis. + */ + +/* ------------------------------------------------------------------ */ +/* Settings */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Settings Settings + * @brief Application settings and configuration. + * + * Centralizes the configuration system, providing persistence and + * runtime access to user preferences and application options. + */ + +/* ------------------------------------------------------------------ */ +/* Tests */ +/* ------------------------------------------------------------------ */ + +/** + * @defgroup Tests Tests + * @brief Automated testing framework. + * + * Provides unit tests, integration tests, and regression checks + * to ensure stability and correctness of the Cockatrice codebase. + */ +