corrected some doxygen tag errors
This commit is contained in:
Christian Kroll
parent
d80f054baf
commit
403c809b64
|
|
@ -50,11 +50,11 @@ enum tetris_bucket_direction_e
|
|||
// status of the bucket
|
||||
enum tetris_bucket_status_e
|
||||
{
|
||||
TETRIS_BUS_HOVERING = 0, /** piece is hovering */
|
||||
TETRIS_BUS_GLIDING = 1, /** piece is gliding on the dump */
|
||||
TETRIS_BUS_DOCKED = 2, /** piece has been docked */
|
||||
TETRIS_BUS_READY = 3, /** ready to get next piece */
|
||||
TETRIS_BUS_GAMEOVER = 4 /** bucket is filled up */
|
||||
TETRIS_BUS_HOVERING = 0, /**< piece is hovering */
|
||||
TETRIS_BUS_GLIDING = 1, /**< piece is gliding on the dump */
|
||||
TETRIS_BUS_DOCKED = 2, /**< piece has been docked */
|
||||
TETRIS_BUS_READY = 3, /**< ready to get next piece */
|
||||
TETRIS_BUS_GAMEOVER = 4 /**< bucket is filled up */
|
||||
};
|
||||
#ifdef NDEBUG
|
||||
typedef uint8_t tetris_bucket_status_t;
|
||||
|
|
@ -66,16 +66,16 @@ enum tetris_bucket_status_e
|
|||
// tetris_bucket_t
|
||||
typedef struct tetris_bucket_s
|
||||
{
|
||||
int8_t nWidth; /** width of bucket */
|
||||
int8_t nHeight; /** height of bucket */
|
||||
tetris_piece_t *pPiece; /** currently falling piece */
|
||||
int8_t nColumn; /** horz. piece pos. (0 is left) */
|
||||
int8_t nRow; /** vert. piece pos. (0 is top) */
|
||||
uint8_t nRowMask; /** removed lines relative to nRow */
|
||||
tetris_bucket_status_t status; /** status of the bucket */
|
||||
int8_t nFirstTaintedRow; /** top most row which has matter */
|
||||
uint16_t nFullRow; /** value of a full row */
|
||||
uint16_t *dump; /** bucket itself */
|
||||
int8_t nWidth; /**< width of bucket */
|
||||
int8_t nHeight; /**< height of bucket */
|
||||
tetris_piece_t *pPiece; /**< currently falling piece */
|
||||
int8_t nColumn; /**< horz. piece pos. (0 is left) */
|
||||
int8_t nRow; /**< vert. piece pos. (0 is top) */
|
||||
uint8_t nRowMask; /**< removed lines relative to nRow */
|
||||
tetris_bucket_status_t status; /**< status of the bucket */
|
||||
int8_t nFirstTaintedRow; /**< top most row which has matter */
|
||||
uint16_t nFullRow; /**< value of a full row */
|
||||
uint16_t *dump; /**< bucket itself */
|
||||
}
|
||||
tetris_bucket_t;
|
||||
|
||||
|
|
@ -83,14 +83,14 @@ tetris_bucket_t;
|
|||
// iterator for predicted dump rows
|
||||
typedef struct tetris_bucket_iterator_s
|
||||
{
|
||||
tetris_bucket_t *pBucket; /** bucket to be examined */
|
||||
uint16_t nPieceMap; /** piece bitmap */
|
||||
int8_t nShift; /** helper variable for shifting piece bitmaps */
|
||||
int8_t nCurrentRow; /** the actual row in the bucket */
|
||||
int8_t nPieceTopRow; /** the highest row index of the piece */
|
||||
int8_t nPieceBottomRow; /** the lowest row index of the piece */
|
||||
int8_t nStopRow; /** the last row to be examined */
|
||||
uint16_t nRowBuffer; /** buffer for returned row */
|
||||
tetris_bucket_t *pBucket; /**< bucket to be examined */
|
||||
uint16_t nPieceMap; /**< piece bitmap */
|
||||
int8_t nShift; /**< helper variable for shifting piece bitmaps */
|
||||
int8_t nCurrentRow; /**< the actual row in the bucket */
|
||||
int8_t nPieceTopRow; /**< the highest row index of the piece */
|
||||
int8_t nPieceBottomRow; /**< the lowest row index of the piece */
|
||||
int8_t nStopRow; /**< the last row to be examined */
|
||||
uint16_t nRowBuffer; /**< buffer for returned row */
|
||||
}
|
||||
tetris_bucket_iterator_t;
|
||||
|
||||
|
|
|
|||
|
|
@ -51,17 +51,18 @@ tetris_bastet_scorepair_t;
|
|||
|
||||
typedef struct tetris_bastet_variant_s
|
||||
{
|
||||
uint16_t nScore; /** score of the player */
|
||||
uint16_t nHighscore; /** high score */
|
||||
uint16_t nHighscoreName; /** champion's initials */
|
||||
uint8_t nLevel; /** current level */
|
||||
uint16_t nLines; /** number of completed lines */
|
||||
tetris_piece_t *pPreviewPiece; /** the piece for the preview */
|
||||
tetris_bucket_t *pBucket; /** bucket to be examined */
|
||||
int16_t *pColScore; /** score impact of every column*/
|
||||
int8_t *pStartingRow; /** starting point for collision*/
|
||||
int8_t *pColHeights; /** predicted column heights */
|
||||
tetris_bastet_scorepair_t nPieceScore[7]; /** score for every piece */
|
||||
uint16_t nScore; /**< score of the player */
|
||||
uint16_t nHighscore; /**< high score */
|
||||
uint16_t nHighscoreName; /**< champion's initials */
|
||||
uint8_t nLevel; /**< current level */
|
||||
uint16_t nLines; /**< number of completed lines */
|
||||
tetris_piece_t *pPreviewPiece; /**< the piece for the preview */
|
||||
tetris_bucket_t *pBucket; /**< bucket to be examined */
|
||||
int16_t *pColScore; /**< score impact of each column*/
|
||||
int8_t *pStartingRow; /**< starting point for
|
||||
collision detection */
|
||||
int8_t *pColHeights; /**< predicted column heights */
|
||||
tetris_bastet_scorepair_t nPieceScore[7]; /**< score for every piece */
|
||||
}
|
||||
tetris_bastet_variant_t;
|
||||
|
||||
|
|
|
|||
|
|
@ -39,13 +39,13 @@ void tetris(void);
|
|||
|
||||
typedef struct tetris_standard_variant_s
|
||||
{
|
||||
uint16_t nScore; /** score of the player */
|
||||
uint16_t nHighscore; /** highscore */
|
||||
uint16_t nHighscoreName; /** champion's initials */
|
||||
uint8_t nLevel; /** current level */
|
||||
uint16_t nLines; /** number of completed lines */
|
||||
tetris_piece_t *pPreviewPiece; /** the piece intended to be the next one */
|
||||
tetris_bearing_t nBearing; /** bearing of the bucket */
|
||||
uint16_t nScore; /**< score of the player */
|
||||
uint16_t nHighscore; /**< highscore */
|
||||
uint16_t nHighscoreName; /**< champion's initials */
|
||||
uint8_t nLevel; /**< current level */
|
||||
uint16_t nLines; /**< number of completed lines */
|
||||
tetris_piece_t *pPreviewPiece; /**< the piece intended to be the next one */
|
||||
tetris_bearing_t nBearing; /**< bearing of the bucket */
|
||||
}
|
||||
tetris_standard_variant_t;
|
||||
|
||||
|
|
|
|||
|
|
@ -39,13 +39,13 @@ enum tetris_view_mode_e
|
|||
/** data structure that drives the view module */
|
||||
typedef struct tetris_view_s
|
||||
{
|
||||
tetris_variant_t const *pVariantMethods; /** variant function pointers */
|
||||
void *pVariant; /** associated variant object */
|
||||
tetris_bucket_t *pBucket; /** associated bucket */
|
||||
tetris_view_mode_t modeCurrent; /** current presentation mode */
|
||||
tetris_view_mode_t modeOld; /** old presentation mode */
|
||||
uint8_t nOldLevel; /** for detecting level changes */
|
||||
tetris_bearing_t nBearing; /** bearing of the bucket */
|
||||
tetris_variant_t const *pVariantMethods; /**< variant function pointers */
|
||||
void *pVariant; /**< associated variant object */
|
||||
tetris_bucket_t *pBucket; /**< associated bucket */
|
||||
tetris_view_mode_t modeCurrent; /**< current presentation mode */
|
||||
tetris_view_mode_t modeOld; /**< old presentation mode */
|
||||
uint8_t nOldLevel; /**< for detecting level changes */
|
||||
tetris_bearing_t nBearing; /**< bearing of the bucket */
|
||||
}
|
||||
tetris_view_t;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue