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

Standardize TODO/FIXME comments to Doxygen \todo format

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

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

2
cockatrice/src/client/network/interfaces/deck_stats_interface.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_stats_interface.h
* @ingroup ApiInterfaces
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECKSTATS_INTERFACE_H
#define DECKSTATS_INTERFACE_H

2
cockatrice/src/client/network/interfaces/tapped_out_interface.h
View file

@ -1,8 +1,8 @@
/**
* @file tapped_out_interface.h
* @ingroup ApiInterfaces
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TAPPEDOUT_INTERFACE_H
#define TAPPEDOUT_INTERFACE_H

2
cockatrice/src/client/network/parsers/deck_link_to_api_transformer.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_link_to_api_transformer.h
* @ingroup ApiInterfaces
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_LINK_TO_API_TRANSFORMER_H
#define DECK_LINK_TO_API_TRANSFORMER_H

2
cockatrice/src/client/network/parsers/interface_json_deck_parser.h
View file

@ -1,8 +1,8 @@
/**
* @file interface_json_deck_parser.h
* @ingroup ApiInterfaces
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef INTERFACE_JSON_DECK_PARSER_H
#define INTERFACE_JSON_DECK_PARSER_H

2
cockatrice/src/client/network/update/card_spoiler/spoiler_background_updater.h
View file

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

2
cockatrice/src/client/network/update/client/client_update_checker.h
View file

@ -1,8 +1,8 @@
/**
* @file client_update_checker.h
* @ingroup ClientUpdate
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CLIENT_UPDATE_CHECKER_H
#define CLIENT_UPDATE_CHECKER_H

2
cockatrice/src/client/network/update/client/release_channel.h
View file

@ -1,8 +1,8 @@
/**
* @file release_channel.h
* @ingroup ClientUpdate
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef RELEASECHANNEL_H
#define RELEASECHANNEL_H

2
cockatrice/src/client/network/update/client/update_downloader.h
View file

@ -1,8 +1,8 @@
/**
* @file update_downloader.h
* @ingroup ClientUpdate
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_UPDATEDOWNLOADER_H
#define COCKATRICE_UPDATEDOWNLOADER_H

2
cockatrice/src/client/settings/cache_settings.h
View file

@ -1,8 +1,8 @@
/**
* @file cache_settings.h
* @ingroup Settings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SETTINGSCACHE_H
#define SETTINGSCACHE_H

2
cockatrice/src/client/settings/card_counter_settings.h
View file

@ -1,8 +1,8 @@
/**
* @file card_counter_settings.h
* @ingroup GameSettings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_COUNTER_SETTINGS_H
#define CARD_COUNTER_SETTINGS_H

2
cockatrice/src/client/settings/shortcut_treeview.h
View file

@ -1,8 +1,8 @@
/**
* @file shortcut_treeview.h
* @ingroup CoreSettings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SHORTCUT_TREEVIEW_H
#define SHORTCUT_TREEVIEW_H

2
cockatrice/src/client/settings/shortcuts_settings.h
View file

@ -1,8 +1,8 @@
/**
* @file shortcuts_settings.h
* @ingroup CoreSettings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SHORTCUTSSETTINGS_H
#define SHORTCUTSSETTINGS_H

2
cockatrice/src/client/sound_engine.h
View file

@ -1,8 +1,8 @@
/**
* @file sound_engine.h
* @ingroup Core
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef SOUNDENGINE_H
#define SOUNDENGINE_H

2
cockatrice/src/filters/deck_filter_string.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_filter_string.h
* @ingroup DeckStorageWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_FILTER_STRING_H
#define DECK_FILTER_STRING_H

2
cockatrice/src/filters/filter_builder.h
View file

@ -1,8 +1,8 @@
/**
* @file filter_builder.h
* @ingroup CardDatabaseModelFilters
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef FILTERBUILDER_H
#define FILTERBUILDER_H

2
cockatrice/src/filters/filter_tree_model.h
View file

@ -1,8 +1,8 @@
/**
* @file filter_tree_model.h
* @ingroup CardDatabaseModelFilters
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef FILTERTREEMODEL_H
#define FILTERTREEMODEL_H

2
cockatrice/src/filters/syntax_help.h
View file

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

2
cockatrice/src/game/abstract_game.h
View file

@ -1,8 +1,8 @@
/**
* @file abstract_game.h
* @ingroup GameLogic
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_ABSTRACT_GAME_H
#define COCKATRICE_ABSTRACT_GAME_H

2
cockatrice/src/game/board/abstract_card_drag_item.h
View file

@ -1,8 +1,8 @@
/**
* @file abstract_card_drag_item.h
* @ingroup GameGraphicsCards
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ABSTRACTCARDDRAGITEM_H
#define ABSTRACTCARDDRAGITEM_H

2
cockatrice/src/game/board/abstract_counter.h
View file

@ -1,8 +1,8 @@
/**
* @file abstract_counter.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COUNTER_H
#define COUNTER_H

2
cockatrice/src/game/board/arrow_item.h
View file

@ -1,8 +1,8 @@
/**
* @file arrow_item.h
* @ingroup GameGraphics
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ARROWITEM_H
#define ARROWITEM_H

2
cockatrice/src/game/board/arrow_target.h
View file

@ -1,8 +1,8 @@
/**
* @file arrow_target.h
* @ingroup GameGraphics
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ARROWTARGET_H
#define ARROWTARGET_H

2
cockatrice/src/game/board/card_drag_item.h
View file

@ -1,8 +1,8 @@
/**
* @file card_drag_item.h
* @ingroup GameGraphicsCards
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDDRAGITEM_H
#define CARDDRAGITEM_H

2
cockatrice/src/game/board/card_item.h
View file

@ -1,8 +1,8 @@
/**
* @file card_item.h
* @ingroup GameGraphicsCards
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDITEM_H
#define CARDITEM_H

2
cockatrice/src/game/board/card_list.h
View file

@ -1,8 +1,8 @@
/**
* @file card_list.h
* @ingroup GameLogicCards
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDLIST_H
#define CARDLIST_H

2
cockatrice/src/game/board/counter_general.h
View file

@ -1,8 +1,8 @@
/**
* @file counter_general.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COUNTER_GENERAL_H
#define COUNTER_GENERAL_H

2
cockatrice/src/game/board/translate_counter_name.h
View file

@ -1,8 +1,8 @@
/**
* @file translate_counter_name.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TRANSLATECOUNTERNAME_H
#define TRANSLATECOUNTERNAME_H

2
cockatrice/src/game/deckview/deck_view.h
View file

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

2
cockatrice/src/game/deckview/deck_view_container.h
View file

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

2
cockatrice/src/game/deckview/tabbed_deck_view_container.h
View file

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

2
cockatrice/src/game/dialogs/dlg_create_token.h
View file

@ -1,8 +1,8 @@
/**
* @file dlg_create_token.h
* @ingroup GameDialogs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DLG_CREATETOKEN_H
#define DLG_CREATETOKEN_H

2
cockatrice/src/game/dialogs/dlg_move_top_cards_until.h
View file

@ -1,8 +1,8 @@
/**
* @file dlg_move_top_cards_until.h
* @ingroup GameDialogs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DLG_MOVE_TOP_CARDS_UNTIL_H
#define DLG_MOVE_TOP_CARDS_UNTIL_H

2
cockatrice/src/game/dialogs/dlg_roll_dice.h
View file

@ -1,8 +1,8 @@
/**
* @file dlg_roll_dice.h
* @ingroup GameDialogs
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DLG_ROLL_DICE_H
#define DLG_ROLL_DICE_H

2
cockatrice/src/game/game.h
View file

@ -1,8 +1,8 @@
/**
* @file game.h
* @ingroup GameLogic
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_GAME_H
#define COCKATRICE_GAME_H

2
cockatrice/src/game/game_event_handler.h
View file

@ -1,8 +1,8 @@
/**
* @file game_event_handler.h
* @ingroup GameLogic
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_GAME_EVENT_HANDLER_H
#define COCKATRICE_GAME_EVENT_HANDLER_H

2
cockatrice/src/game/game_meta_info.h
View file

@ -1,8 +1,8 @@
/**
* @file game_meta_info.h
* @ingroup GameLogic
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef GAME_META_INFO_H
#define GAME_META_INFO_H

2
cockatrice/src/game/game_state.h
View file

@ -1,8 +1,8 @@
/**
* @file game_state.h
* @ingroup GameLogic
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_GAME_STATE_H
#define COCKATRICE_GAME_STATE_H

2
cockatrice/src/game/game_view.h
View file

@ -1,8 +1,8 @@
/**
* @file game_view.h
* @ingroup GameGraphics
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef GAMEVIEW_H
#define GAMEVIEW_H

2
cockatrice/src/game/hand_counter.h
View file

@ -1,8 +1,8 @@
/**
* @file hand_counter.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef HANDCOUNTER_H
#define HANDCOUNTER_H

2
cockatrice/src/game/log/message_log_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file message_log_widget.h
* @ingroup GameWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MESSAGELOGWIDGET_H
#define MESSAGELOGWIDGET_H

2
cockatrice/src/game/phase.h
View file

@ -1,8 +1,8 @@
/**
* @file phase.h
* @ingroup GameLogic
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PHASE_H
#define PHASE_H

2
cockatrice/src/game/phases_toolbar.h
View file

@ -2,8 +2,8 @@
* @file phases_toolbar.h
* @ingroup GameGraphics
* @ingroup GameWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PHASESTOOLBAR_H
#define PHASESTOOLBAR_H

2
cockatrice/src/game/player/card_menu_action_type.h
View file

@ -1,8 +1,8 @@
/**
* @file card_menu_action_type.h
* @ingroup GameMenusPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_CARD_MENU_ACTION_TYPE_H
#define COCKATRICE_CARD_MENU_ACTION_TYPE_H

2
cockatrice/src/game/player/event_processing_options.h
View file

@ -1,8 +1,8 @@
/**
* @file event_processing_options.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_EVENT_PROCESSING_OPTIONS_H
#define COCKATRICE_EVENT_PROCESSING_OPTIONS_H

2
cockatrice/src/game/player/menu/card_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file card_menu.h
* @ingroup GameMenusCards
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_CARD_MENU_H
#define COCKATRICE_CARD_MENU_H

2
cockatrice/src/game/player/menu/custom_zone_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file custom_zone_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_CUSTOM_ZONE_MENU_H
#define COCKATRICE_CUSTOM_ZONE_MENU_H

2
cockatrice/src/game/player/menu/grave_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file grave_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_GRAVE_MENU_H
#define COCKATRICE_GRAVE_MENU_H

2
cockatrice/src/game/player/menu/hand_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file hand_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_HAND_MENU_H
#define COCKATRICE_HAND_MENU_H

2
cockatrice/src/game/player/menu/library_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file library_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_LIBRARY_MENU_H
#define COCKATRICE_LIBRARY_MENU_H

2
cockatrice/src/game/player/menu/move_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file move_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_MOVE_MENU_H
#define COCKATRICE_MOVE_MENU_H

2
cockatrice/src/game/player/menu/pt_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file pt_menu.h
* @ingroup GameMenusCards
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PT_MENU_H
#define COCKATRICE_PT_MENU_H

2
cockatrice/src/game/player/menu/rfg_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file rfg_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_RFG_MENU_H
#define COCKATRICE_RFG_MENU_H

2
cockatrice/src/game/player/menu/say_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file say_menu.h
* @ingroup GameMenusPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_SAY_MENU_H
#define COCKATRICE_SAY_MENU_H

2
cockatrice/src/game/player/menu/sideboard_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file sideboard_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_SIDEBOARD_MENU_H
#define COCKATRICE_SIDEBOARD_MENU_H

2
cockatrice/src/game/player/menu/utility_menu.h
View file

@ -1,8 +1,8 @@
/**
* @file utility_menu.h
* @ingroup GameMenusPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_UTILITY_MENU_H
#define COCKATRICE_UTILITY_MENU_H

2
cockatrice/src/game/player/player_actions.h
View file

@ -2,8 +2,8 @@
* @file player_actions.h
* @ingroup GameLogicActions
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PLAYER_ACTIONS_H
#define COCKATRICE_PLAYER_ACTIONS_H

2
cockatrice/src/game/player/player_area.h
View file

@ -1,8 +1,8 @@
/**
* @file player_area.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PLAYER_AREA_H
#define COCKATRICE_PLAYER_AREA_H

2
cockatrice/src/game/player/player_event_handler.h
View file

@ -1,8 +1,8 @@
/**
* @file player_event_handler.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PLAYER_EVENT_HANDLER_H
#define COCKATRICE_PLAYER_EVENT_HANDLER_H

2
cockatrice/src/game/player/player_graphics_item.h
View file

@ -1,8 +1,8 @@
/**
* @file player_graphics_item.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PLAYER_GRAPHICS_ITEM_H
#define COCKATRICE_PLAYER_GRAPHICS_ITEM_H

2
cockatrice/src/game/player/player_info.h
View file

@ -1,8 +1,8 @@
/**
* @file player_info.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PLAYER_INFO_H
#define COCKATRICE_PLAYER_INFO_H

2
cockatrice/src/game/player/player_list_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file player_list_widget.h
* @ingroup GameWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PLAYERLISTWIDGET_H
#define PLAYERLISTWIDGET_H

2
cockatrice/src/game/player/player_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file player.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PLAYER_H
#define PLAYER_H

2
cockatrice/src/game/player/player_manager.h
View file

@ -1,8 +1,8 @@
/**
* @file player_manager.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PLAYER_MANAGER_H
#define COCKATRICE_PLAYER_MANAGER_H

2
cockatrice/src/game/player/player_target.h
View file

@ -1,8 +1,8 @@
/**
* @file player_target.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PLAYERTARGET_H
#define PLAYERTARGET_H

2
cockatrice/src/game/replay.h
View file

@ -2,8 +2,8 @@
* @file replay.h
* @ingroup GameLogic
* @ingroup Replay
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_REPLAY_H
#define COCKATRICE_REPLAY_H

2
cockatrice/src/game/zones/card_zone_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file card_zone_logic.h
* @ingroup GameLogicZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_CARD_ZONE_LOGIC_H
#define COCKATRICE_CARD_ZONE_LOGIC_H

2
cockatrice/src/game/zones/hand_zone_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file hand_zone_logic.h
* @ingroup GameLogicZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_HAND_ZONE_LOGIC_H
#define COCKATRICE_HAND_ZONE_LOGIC_H

2
cockatrice/src/game/zones/pile_zone_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file pile_zone_logic.h
* @ingroup GameLogicZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_PILE_ZONE_LOGIC_H
#define COCKATRICE_PILE_ZONE_LOGIC_H

2
cockatrice/src/game/zones/stack_zone_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file stack_zone_logic.h
* @ingroup GameLogicZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_STACK_ZONE_LOGIC_H
#define COCKATRICE_STACK_ZONE_LOGIC_H

2
cockatrice/src/game/zones/table_zone_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file table_zone_logic.h
* @ingroup GameLogicZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_TABLE_ZONE_LOGIC_H
#define COCKATRICE_TABLE_ZONE_LOGIC_H

2
cockatrice/src/game/zones/view_zone_logic.h
View file

@ -1,8 +1,8 @@
/**
* @file view_zone_logic.h
* @ingroup GameLogicZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_VIEW_ZONE_LOGIC_H
#define COCKATRICE_VIEW_ZONE_LOGIC_H

2
cockatrice/src/game_graphics/board/abstract_graphics_item.h
View file

@ -1,8 +1,8 @@
/**
* @file abstract_graphics_item.h
* @ingroup GameGraphics
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ABSTRACTGRAPHICSITEM_H
#define ABSTRACTGRAPHICSITEM_H

2
cockatrice/src/game_graphics/board/graphics_item_type.h
View file

@ -1,8 +1,8 @@
/**
* @file graphics_item_type.h
* @ingroup GameGraphics
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COCKATRICE_GRAPHICS_ITEM_TYPE_H
#define COCKATRICE_GRAPHICS_ITEM_TYPE_H

2
cockatrice/src/game_graphics/zones/pile_zone.h
View file

@ -1,8 +1,8 @@
/**
* @file pile_zone.h
* @ingroup GameGraphicsZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PILEZONE_H
#define PILEZONE_H

11
cockatrice/src/game_graphics/zones/table_zone.h
View file

@ -1,8 +1,8 @@
/**
* @file table_zone.h
* @ingroup GameGraphicsZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef TABLEZONE_H
#define TABLEZONE_H
@ -11,13 +11,12 @@
#include "../../game/zones/table_zone_logic.h"
#include "select_zone.h"
/*
* TableZone is the grid based rect where CardItems may be placed.
* It is the main play zone and can be customized with background images.
/**
* @brief TableZone is the grid based rect where CardItems may be placed.
*
* TODO: Refactor methods to make more readable, extract some logic to
* private methods (Im looking at you TableZone::reorganizeCards())
* It is the main play zone and can be customized with background images.
*/
//! \todo Refactor methods to make more readable, extract logic to private methods (especially reorganizeCards()).
class TableZone : public SelectZone
{
Q_OBJECT

2
cockatrice/src/game_graphics/zones/view_zone.h
View file

@ -1,8 +1,8 @@
/**
* @file view_zone.h
* @ingroup GameGraphicsZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ZONEVIEWERZONE_H
#define ZONEVIEWERZONE_H

2
cockatrice/src/game_graphics/zones/view_zone_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file view_zone_widget.h
* @ingroup GameGraphicsZones
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef ZONEVIEWWIDGET_H
#define ZONEVIEWWIDGET_H

2
cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp
View file

@ -53,12 +53,12 @@ QList<CardSetPtr> CardPictureToLoad::extractSetsSorted(const ExactCard &card)
* PrintingInfo for the set is returned.
*
* This method only exists to maintain existing behavior.
* TODO: check if going through all sets is still necessary after the ExactCard refactor.
*
* @param card The card to look in
* @param setName The set's short name
* @return A PrintingInfo, or a default-constructed PrintingInfo if the set name is not in the CardInfo.
*/
//! \todo Check if going through all sets is still necessary after the ExactCard refactor.
static PrintingInfo findPrintingForSet(const ExactCard &card, const QString &setName)
{
SetToPrintingsMap setsToPrintings = card.getInfo().getSets();

2
cockatrice/src/interface/deck_loader/deck_loader.h
View file

@ -1,8 +1,8 @@
/**
* @file deck_loader.h
* @ingroup ImportExport
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef DECK_LOADER_H
#define DECK_LOADER_H

2
cockatrice/src/interface/key_signals.h
View file

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

1
cockatrice/src/interface/layouts/flow_layout.h
View file

@ -4,6 +4,7 @@
* @brief A QLayout subclass that arranges child widgets in wrapping rows (horizontal flow)
* or wrapping columns (vertical flow).
*/
//! \todo Document this file.
#ifndef FLOW_LAYOUT_H
#define FLOW_LAYOUT_H

2
cockatrice/src/interface/layouts/overlap_layout.cpp
View file

@ -223,7 +223,7 @@ void OverlapLayout::setGeometry(const QRect &rect)
const int yPos = rect.top() + currentRow * (maxItemHeight - overlapOffsetHeight);
item->setGeometry(QRect(xPos, yPos, maxItemWidth, maxItemHeight));
// TODO: Figure this out properly or maybe adjust size hint to account for this?
//! \todo Figure this out properly or maybe adjust size hint to account for this.
// Update row and column indices based on the layout direction.
if (overlapDirection == Qt::Horizontal) {
currentColumn++;

2
cockatrice/src/interface/layouts/overlap_layout.h
View file

@ -1,8 +1,8 @@
/**
* @file overlap_layout.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef OVERLAP_LAYOUT_H
#define OVERLAP_LAYOUT_H

2
cockatrice/src/interface/logger.h
View file

@ -1,8 +1,8 @@
/**
* @file logger.h
* @ingroup Core
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef LOGGER_H
#define LOGGER_H

2
cockatrice/src/interface/pixel_map_generator.h
View file

@ -1,8 +1,8 @@
/**
* @file pixel_map_generator.h
* @ingroup UI
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef PIXMAPGENERATOR_H
#define PIXMAPGENERATOR_H

2
cockatrice/src/interface/theme_manager.cpp
View file

@ -92,7 +92,7 @@ struct PaletteColorInfo
ThemeManager::ThemeManager(QObject *parent) : QObject(parent)
{
defaultStyleName = qApp->style()->objectName();
// FIXME workaround for windows11 style being broken
//! \todo Workaround for windows11 style being broken.
if (defaultStyleName == "windows11") {
defaultStyleName = "windowsvista";
}

2
cockatrice/src/interface/theme_manager.h
View file

@ -1,8 +1,8 @@
/**
* @file theme_manager.h
* @ingroup CoreSettings
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef THEMEMANAGER_H
#define THEMEMANAGER_H

2
cockatrice/src/interface/widgets/cards/additional_info/color_identity_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file color_identity_widget.h
* @ingroup CardExtraInfoWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef COLOR_IDENTITY_WIDGET_H
#define COLOR_IDENTITY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/additional_info/mana_cost_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_cost_widget.h
* @ingroup CardExtraInfoWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_COST_WIDGET_H
#define MANA_COST_WIDGET_H

2
cockatrice/src/interface/widgets/cards/additional_info/mana_symbol_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file mana_symbol_widget.h
* @ingroup CardExtraInfoWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef MANA_SYMBOL_WIDGET_H
#define MANA_SYMBOL_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_group_display_widgets/card_group_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_group_display_widget.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_GROUP_DISPLAY_WIDGET_H
#define CARD_GROUP_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_group_display_widgets/flat_card_group_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file flat_card_group_display_widget.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef FLAT_CARD_GROUP_DISPLAY_WIDGET_H
#define FLAT_CARD_GROUP_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_group_display_widgets/overlapped_card_group_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file overlapped_card_group_display_widget.h
* @ingroup DeckEditorCardGroupWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef OVERLAPPED_CARD_GROUP_DISPLAY_WIDGET_H
#define OVERLAPPED_CARD_GROUP_DISPLAY_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_display_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_display_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDINFOWIDGET_H
#define CARDINFOWIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_frame_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_frame_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDFRAME_H
#define CARDFRAME_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_art_crop_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_picture_art_crop_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_INFO_PICTURE_ART_CROP_WIDGET_H
#define CARD_INFO_PICTURE_ART_CROP_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_enlarged_widget.h
View file

@ -2,8 +2,8 @@
* @file card_info_picture_enlarged_widget.h
* @ingroup CardWigets
* @ingroup DeckEditorWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_PICTURE_ENLARGED_WIDGET_H
#define CARD_PICTURE_ENLARGED_WIDGET_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_picture_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARD_INFO_PICTURE_H
#define CARD_INFO_PICTURE_H

2
cockatrice/src/interface/widgets/cards/card_info_picture_with_text_overlay_widget.h
View file

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

2
cockatrice/src/interface/widgets/cards/card_info_text_widget.h
View file

@ -1,8 +1,8 @@
/**
* @file card_info_text_widget.h
* @ingroup CardWidgets
* @brief TODO: Document this.
*/
//! \todo Document this file.
#ifndef CARDINFOTEXT_H
#define CARDINFOTEXT_H

Some files were not shown because too many files have changed in this diff Show more