[Documentation] Sort *every* file into a doxygen group. (#6198)

* 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 <Bruebach.Lukas@bdosecurity.de>
This commit is contained in:
BruebachL 2025-09-30 12:13:32 +02:00 committed by GitHub
parent 22c6756ce0
commit f8c4f774cf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
297 changed files with 2368 additions and 19 deletions

View file

@ -1,3 +1,9 @@
/**
* @file abstract_client.h
* @ingroup Client
* @brief TODO: Document this.
*/
#ifndef ABSTRACTCLIENT_H
#define ABSTRACTCLIENT_H

View file

@ -1,3 +1,11 @@
/**
* @file chat_view.h
* @ingroup Network
* @ingroup Lobby
* @ingroup Widgets
* @brief TODO: Document this.
*/
#ifndef CHATVIEW_H
#define CHATVIEW_H

View file

@ -1,3 +1,9 @@
/**
* @file game_selector.h
* @ingroup Lobby
* @brief TODO: Document this.
*/
#ifndef GAMESELECTOR_H
#define GAMESELECTOR_H

View file

@ -1,3 +1,10 @@
/**
* @file games_model.h
* @ingroup Lobby
* @ingroup Network
* @brief TODO: Document this.
*/
#ifndef GAMESMODEL_H
#define GAMESMODEL_H

View file

@ -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

View file

@ -1,3 +1,9 @@
/**
* @file local_client.h
* @ingroup Client
* @brief TODO: Document this.
*/
#ifndef LOCALCLIENT_H
#define LOCALCLIENT_H

View file

@ -1,3 +1,9 @@
/**
* @file local_server.h
* @ingroup Server
* @brief TODO: Document this.
*/
#ifndef LOCALSERVER_H
#define LOCALSERVER_H

View file

@ -1,3 +1,9 @@
/**
* @file local_server_interface.h
* @ingroup Server
* @brief TODO: Document this.
*/
#ifndef LOCALSERVERINTERFACE_H
#define LOCALSERVERINTERFACE_H

View file

@ -1,3 +1,9 @@
/**
* @file pending_command.h
* @ingroup Network
* @brief TODO: Document this.
*/
#ifndef PENDING_COMMAND_H
#define PENDING_COMMAND_H

View file

@ -1,3 +1,9 @@
/**
* @file remote_client.h
* @ingroup Client
* @brief TODO: Document this.
*/
#ifndef REMOTECLIENT_H
#define REMOTECLIENT_H

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -1,3 +1,10 @@
/**
* @file user_info_box.h
* @ingroup Network
* @ingroup Lobby
* @brief TODO: Document this.
*/
#ifndef USERINFOBOX_H
#define USERINFOBOX_H

View file

@ -1,3 +1,9 @@
/**
* @file user_info_connection.h
* @ingroup Network
* @brief TODO: Document this.
*/
#ifndef USERCONNECTION_INFORMATION_H
#define USERCONNECTION_INFORMATION_H

View file

@ -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

View file

@ -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

View file

@ -1,3 +1,10 @@
/**
* @file user_list_widget.h
* @ingroup Network
* @ingroup Lobby
* @brief TODO: Document this.
*/
#ifndef USERLIST_H
#define USERLIST_H