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

View file

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

View file

@ -1,3 +1,9 @@
/**
* @file card_menu.h
* @ingroup GameMenusCards
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_CARD_MENU_H
#define COCKATRICE_CARD_MENU_H

View file

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

View file

@ -1,3 +1,9 @@
/**
* @file grave_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_GRAVE_MENU_H
#define COCKATRICE_GRAVE_MENU_H

View file

@ -1,3 +1,9 @@
/**
* @file hand_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_HAND_MENU_H
#define COCKATRICE_HAND_MENU_H

View file

@ -1,3 +1,9 @@
/**
* @file library_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_LIBRARY_MENU_H
#define COCKATRICE_LIBRARY_MENU_H

View file

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

View file

@ -1,3 +1,9 @@
/**
* @file player_menu.h
* @ingroup GameMenusPlayers
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_PLAYER_MENU_H
#define COCKATRICE_PLAYER_MENU_H

View file

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

View file

@ -1,3 +1,9 @@
/**
* @file rfg_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_RFG_MENU_H
#define COCKATRICE_RFG_MENU_H

View file

@ -1,3 +1,9 @@
/**
* @file say_menu.h
* @ingroup GameMenusPlayers
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_SAY_MENU_H
#define COCKATRICE_SAY_MENU_H

View file

@ -1,3 +1,9 @@
/**
* @file sideboard_menu.h
* @ingroup GameMenusZones
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_SIDEBOARD_MENU_H
#define COCKATRICE_SIDEBOARD_MENU_H

View file

@ -1,3 +1,9 @@
/**
* @file utility_menu.h
* @ingroup GameMenusPlayers
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_UTILITY_MENU_H
#define COCKATRICE_UTILITY_MENU_H

View file

@ -1,3 +1,9 @@
/**
* @file player.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
#ifndef PLAYER_H
#define PLAYER_H

View file

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

View file

@ -1,3 +1,9 @@
/**
* @file player_area.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_PLAYER_AREA_H
#define COCKATRICE_PLAYER_AREA_H

View file

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

View file

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

View file

@ -1,3 +1,9 @@
/**
* @file player_info.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_PLAYER_INFO_H
#define COCKATRICE_PLAYER_INFO_H

View file

@ -1,3 +1,9 @@
/**
* @file player_list_widget.h
* @ingroup GameWidgets
* @brief TODO: Document this.
*/
#ifndef PLAYERLISTWIDGET_H
#define PLAYERLISTWIDGET_H

View file

@ -1,3 +1,9 @@
/**
* @file player_manager.h
* @ingroup GameLogicPlayers
* @brief TODO: Document this.
*/
#ifndef COCKATRICE_PLAYER_MANAGER_H
#define COCKATRICE_PLAYER_MANAGER_H

View file

@ -1,3 +1,9 @@
/**
* @file player_target.h
* @ingroup GameGraphicsPlayers
* @brief TODO: Document this.
*/
#ifndef PLAYERTARGET_H
#define PLAYERTARGET_H