add header comments to editor classes

This commit is contained in:
scawful
2024-04-14 00:04:17 -05:00
parent f653517026
commit 96defd6e5e
6 changed files with 93 additions and 5 deletions

View File

@@ -9,17 +9,41 @@ namespace yaze {
namespace app {
namespace editor {
/**
* @brief The SpriteEditor class represents a sprite editor that inherits from
* SharedROM.
*
* This class provides functionality for updating the sprite editor, drawing the
* editor table, drawing the sprite canvas, and drawing the current sheets.
*/
class SpriteEditor : public SharedROM {
public:
/**
* @brief Updates the sprite editor.
*
* @return An absl::Status indicating the success or failure of the update.
*/
absl::Status Update();
private:
/**
* @brief Draws the editor table.
*/
void DrawEditorTable();
/**
* @brief Draws the sprite canvas.
*/
void DrawSpriteCanvas();
/**
* @brief Draws the current sheets.
*/
void DrawCurrentSheets();
uint8_t current_sheets_[8];
bool sheets_loaded_ = false;
uint8_t current_sheets_[8]; /**< Array to store the current sheets. */
bool sheets_loaded_ =
false; /**< Flag indicating whether the sheets are loaded or not. */
};
} // namespace editor