Added documentation to get_played/hand_distribution (#343)
* Added documentation to get_played/hand_distribution * Documented get_played_distribution() behavior
This commit is contained in:
+17
-2
@@ -5,8 +5,23 @@
|
||||
|
||||
#include <tonc.h>
|
||||
|
||||
void get_hand_distribution(u8* ranks_out, u8* suits_out);
|
||||
void get_played_distribution(u8* ranks_out, u8* suits_out);
|
||||
/**
|
||||
* @brief Outputs the distribution of ranks and suits in the hand
|
||||
* @param ranks_out output - updated such as ranks_out[rank] is the number of cards of rank in the
|
||||
* hand. Must be of size NUM_RANKS.
|
||||
* @param suits_out output - updated such as suits_out[suit] is the number of cards if suit in the
|
||||
* hand Must be of size NUM_SUITS
|
||||
*/
|
||||
void get_hand_distribution(u8 ranks_out[NUM_RANKS], u8 suits_out[NUM_SUITS]);
|
||||
|
||||
/**
|
||||
* @brief Outputs the distribution of ranks and suits in the played stack
|
||||
* @param ranks_out output - updated such as ranks_out[rank] is the number of cards of rank in the
|
||||
* played stack. Must be of size NUM_RANKS.
|
||||
* @param suits_out output - updated such as suits_out[suit] is the number of cards if suit in the
|
||||
* played stack. Must be of size NUM_SUITS
|
||||
*/
|
||||
void get_played_distribution(u8 ranks_out[NUM_RANKS], u8 suits_out[NUM_SUITS]);
|
||||
|
||||
u8 hand_contains_n_of_a_kind(u8* ranks);
|
||||
bool hand_contains_two_pair(u8* ranks);
|
||||
|
||||
Reference in New Issue
Block a user