mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2025-12-05 20:39:59 -08:00
Move doc comments to correct place (#6123)
* Move docs for ViewZone * Update docs * move docs for updateCardMenu * Fix link in doc * format
This commit is contained in:
@@ -438,14 +438,6 @@ bool Player::clearCardsToDelete()
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a card menu from the given card and sets it as the currently active card menu.
|
||||
* Will first check if the card should have a card menu, and no-ops if not.
|
||||
*
|
||||
* @param card The card to create the menu for. Pass nullptr to disable the card menu.
|
||||
* @return The new card menu, or nullptr if failed.
|
||||
*/
|
||||
|
||||
void Player::setActive(bool _active)
|
||||
{
|
||||
active = _active;
|
||||
|
||||
@@ -86,7 +86,7 @@ void PlayerActions::playCard(CardItem *card, bool faceDown)
|
||||
}
|
||||
|
||||
/**
|
||||
* Like {@link Player::playCard}, but forces the card to be played to the table zone.
|
||||
* Like {@link PlayerActions::playCard}, but forces the card to be played to the table zone.
|
||||
* Cards with tablerow 3 (the stack) will be played to tablerow 1 (the noncreatures row).
|
||||
*/
|
||||
void PlayerActions::playCardToTable(const CardItem *card, bool faceDown)
|
||||
|
||||
@@ -838,6 +838,13 @@ QMenu *PlayerMenu::createCardMenu(const CardItem *card)
|
||||
return cardMenu;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a card menu from the given card and sets it as the currently active card menu.
|
||||
* Will first check if the card should have a card menu, and no-ops if not.
|
||||
*
|
||||
* @param card The card to create the menu for. Pass nullptr to disable the card menu.
|
||||
* @return The new card menu, or nullptr if failed.
|
||||
*/
|
||||
QMenu *PlayerMenu::updateCardMenu(const CardItem *card)
|
||||
{
|
||||
if (!card) {
|
||||
|
||||
@@ -15,6 +15,7 @@
|
||||
/**
|
||||
* @param _player the player that the zone belongs to
|
||||
* @param _name internal name of the zone
|
||||
* @param _hasCardAttr whether cards in the zone can have attributes set on them
|
||||
* @param _isShufflable whether it makes sense to shuffle this zone by default after viewing it
|
||||
* @param _contentsKnown whether the cards in the zone are known to the client
|
||||
* @param parent the parent QObject.
|
||||
|
||||
@@ -3,6 +3,12 @@
|
||||
#include "../../../settings/cache_settings.h"
|
||||
#include "../../board/card_item.h"
|
||||
|
||||
/**
|
||||
* @param _player the player that the cards are revealed to.
|
||||
* @param _origZone the zone the cards were revealed from.
|
||||
* @param _revealZone if false, the cards will be face down.
|
||||
* @param _writeableRevealZone whether the player can interact with the revealed cards.
|
||||
*/
|
||||
ZoneViewZoneLogic::ZoneViewZoneLogic(Player *_player,
|
||||
CardZoneLogic *_origZone,
|
||||
int _numberCards,
|
||||
|
||||
@@ -18,10 +18,6 @@
|
||||
#include <QtMath>
|
||||
|
||||
/**
|
||||
* @param _p the player that the cards are revealed to.
|
||||
* @param _origZone the zone the cards were revealed from.
|
||||
* @param _revealZone if false, the cards will be face down.
|
||||
* @param _writeableRevealZone whether the player can interact with the revealed cards.
|
||||
* @param parent the parent QGraphicsWidget containing the reveal zone
|
||||
*/
|
||||
ZoneViewZone::ZoneViewZone(ZoneViewZoneLogic *_logic, QGraphicsItem *parent)
|
||||
|
||||
Reference in New Issue
Block a user