mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-07-04 20:43:54 -07:00
[Documentation] Doxygen regroup files and reorder group structure (#6208)
* Regroup a whole bunch of files. Took 1 hour 38 minutes * Reorder the structure. Took 15 minutes * Link some more things. Took 18 minutes * More links. Took 14 minutes --------- Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
This commit is contained in:
parent
201750c89f
commit
c5b361e94d
53 changed files with 516 additions and 375 deletions
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file deck_link_to_api_transformer.h
|
||||
* @ingroup Network
|
||||
* @ingroup ApiInterfaces
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file interface_json_deck_parser.h
|
||||
* @ingroup Network
|
||||
* @ingroup ApiInterfaces
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file spoiler_background_updater.h
|
||||
* @ingroup Network
|
||||
* @ingroup Client
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
/**
|
||||
* @file tapped_out_interface.h
|
||||
* @ingroup ImportExport
|
||||
* @ingroup Parsing
|
||||
* @ingroup Network
|
||||
* @ingroup ApiInterfaces
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
/**
|
||||
* @file deck_stats_interface.h
|
||||
* @ingroup ImportExport
|
||||
* @ingroup Parsing
|
||||
* @ingroup Network
|
||||
* @ingroup ApiInterfaces
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_connect.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup ConnectionDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
/**
|
||||
* @file dlg_convert_deck_to_cod_format.h
|
||||
* @ingroup Dialogs
|
||||
* @ingroup DeckStorageWidgets
|
||||
* @ingroup ImportExport
|
||||
* @ingroup LocalDeckStorageDialogs
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file dlg_create_game.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup Lobby
|
||||
* @ingroup RoomDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_edit_avatar.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup AccountDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_edit_password.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup AccountDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file dlg_filter_games.h
|
||||
* @ingroup Lobby
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup RoomDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_forgot_password_challenge.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup AccountDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_forgot_password_request.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup AccountDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_forgot_password_reset.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup AccountDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file dlg_load_deck.h
|
||||
* @ingroup Dialogs
|
||||
* @ingroup ImportExport
|
||||
* @ingroup LocalDeckStorageDialogs
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file dlg_load_deck_from_clipboard.h
|
||||
* @ingroup Dialogs
|
||||
* @ingroup ImportExport
|
||||
* @ingroup LocalDeckStorageDialogs
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file dlg_load_deck_from_website.h
|
||||
* @ingroup Dialogs
|
||||
* @ingroup ImportExport
|
||||
* @ingroup RemoteDeckStorageDialogs
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file dlg_load_remote_deck.h
|
||||
* @ingroup Dialogs
|
||||
* @ingroup ImportExport
|
||||
* @ingroup RemoteDeckStorageDialogs
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_register.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup AccountDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_startup_card_check.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup CardDatabaseUpdateDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_update.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup ClientUpdateDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file dlg_view_log.h
|
||||
* @ingroup NetworkDialogs
|
||||
* @ingroup ServerLogDialogs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file theme_manager.h
|
||||
* @ingroup Core
|
||||
* @ingroup Settings
|
||||
* @ingroup CoreSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
/**
|
||||
* @file chat_view.h
|
||||
* @ingroup Network
|
||||
* @ingroup NetworkingWidgets
|
||||
* @ingroup Lobby
|
||||
* @ingroup Widgets
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file games_model.h
|
||||
* @ingroup Lobby
|
||||
* @ingroup Network
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file handle_public_servers.h
|
||||
* @ingroup Network
|
||||
* @ingroup Server
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file pending_command.h
|
||||
* @ingroup Network
|
||||
* @ingroup Messages
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file remote_decklist_tree_widget.h
|
||||
* @ingroup Client
|
||||
* @ingroup NetworkingWidgets
|
||||
* @ingroup DeckStorageWidgets
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
* @file remote_replay_list_tree_widget.h
|
||||
* @ingroup DeckStorageWidgets
|
||||
* @ingroup Replays
|
||||
* @ingroup Client
|
||||
* @ingroup NetworkingWidgets
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/**
|
||||
* @file user_info_box.h
|
||||
* @ingroup Network
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file user_info_connection.h
|
||||
* @ingroup Network
|
||||
* @ingroup Client
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/**
|
||||
* @file user_list_manager.h
|
||||
* @ingroup Network
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/**
|
||||
* @file user_list_widget.h
|
||||
* @ingroup Network
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
/**
|
||||
* @file cache_settings.h
|
||||
* @ingroup Network
|
||||
* @ingroup Settings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file card_counter_settings.h
|
||||
* @ingroup Settings
|
||||
* @ingroup GameSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* @file card_database_settings.h
|
||||
* @ingroup CardDatabase
|
||||
* @ingroup Settings
|
||||
* @ingroup CardSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file card_override_settings.h
|
||||
* @ingroup Settings
|
||||
* @ingroup CardSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file debug_settings.h
|
||||
* @ingroup Core
|
||||
* @ingroup Settings
|
||||
* @ingroup CoreSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file download_settings.h
|
||||
* @ingroup Network
|
||||
* @ingroup Settings
|
||||
* @ingroup NetworkSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* @file game_filters_settings.h
|
||||
* @ingroup Lobby
|
||||
* @ingroup Settings
|
||||
* @ingroup GameSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file layouts_settings.h
|
||||
* @ingroup Settings
|
||||
* @ingroup CoreSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file message_settings.h
|
||||
* @ingroup Network
|
||||
* @ingroup Settings
|
||||
* @ingroup NetworkSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file recents_settings.h
|
||||
* @ingroup DeckStorage
|
||||
* @ingroup Settings
|
||||
* @ingroup DeckSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
/**
|
||||
* @file servers_settings.h
|
||||
* @ingroup Network
|
||||
* @ingroup Settings
|
||||
* @ingroup NetworkSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file shortcut_treeview.h
|
||||
* @ingroup Settings
|
||||
* @ingroup CoreSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file shortcuts_settings.h
|
||||
* @ingroup Settings
|
||||
* @ingroup CoreSettings
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file tab_account.h
|
||||
* @ingroup NetworkingTabs
|
||||
* @ingroup AccountTabs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file tab_admin.h
|
||||
* @ingroup NetworkingTabs
|
||||
* @ingroup ServerTabs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file tab_logs.h
|
||||
* @ingroup NetworkingTabs
|
||||
* @ingroup ServerTabs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file tab_message.h
|
||||
* @ingroup NetworkingTabs
|
||||
* @ingroup MessagingTabs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file tab_room.h
|
||||
* @ingroup NetworkingTabs
|
||||
* @ingroup RoomTabs
|
||||
* @ingroup Lobby
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
* @file tab_server.h
|
||||
* @ingroup NetworkingTabs
|
||||
* @ingroup ServerTabs
|
||||
* @brief TODO: Document this.
|
||||
*/
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue