diff --git a/src/app/core/common.h b/src/app/core/common.h index 3284794b..9feb1964 100644 --- a/src/app/core/common.h +++ b/src/app/core/common.h @@ -28,7 +28,7 @@ namespace core { class ExperimentFlags { public: struct Flags { - // Bitmap manager abstraction to manage graphics bin of ROM. + // Bitmap manager abstraction to manage graphics bin of Rom. bool kUseBitmapManager = true; // Log instructions to the GUI debugger. @@ -39,11 +39,11 @@ class ExperimentFlags { // ported away from that eventually. bool kUseNewImGuiInput = false; - // Flag to enable the saving of all palettes to the ROM. + // Flag to enable the saving of all palettes to the Rom. bool kSaveAllPalettes = false; // Flag to enable the change queue, which could have any anonymous - // save routine for the ROM. In practice, just the overworld tilemap + // save routine for the Rom. In practice, just the overworld tilemap // and tile32 save. bool kSaveWithChangeQueue = false; @@ -60,7 +60,7 @@ class ExperimentFlags { // Uses texture streaming from SDL for my dynamic updates. bool kLoadTexturesAsStreaming = true; - // Save dungeon map edits to the ROM. + // Save dungeon map edits to the Rom. bool kSaveDungeonMaps = false; // Log to the console. @@ -71,19 +71,19 @@ class ExperimentFlags { // Load and render overworld sprites to the screen. Unstable. bool kDrawOverworldSprites = false; - // Save overworld map edits to the ROM. + // Save overworld map edits to the Rom. bool kSaveOverworldMaps = true; - // Save overworld entrances to the ROM. + // Save overworld entrances to the Rom. bool kSaveOverworldEntrances = true; - // Save overworld exits to the ROM. + // Save overworld exits to the Rom. bool kSaveOverworldExits = true; - // Save overworld items to the ROM. + // Save overworld items to the Rom. bool kSaveOverworldItems = true; - // Save overworld properties to the ROM. + // Save overworld properties to the Rom. bool kSaveOverworldProperties = true; } overworld; }; diff --git a/src/app/editor/master_editor.h b/src/app/editor/master_editor.h index dd4692e6..cec820bc 100644 --- a/src/app/editor/master_editor.h +++ b/src/app/editor/master_editor.h @@ -36,13 +36,13 @@ namespace editor { /** * @class MasterEditor - * @brief The MasterEditor class represents the main editor for a ROM in the + * @brief The MasterEditor class represents the main editor for a Rom in the * Yaze application. * * This class inherits from SharedRom, GfxContext, and ExperimentFlags, and * provides functionality for setting up the screen, updating the editor, and * shutting down the editor. It also includes methods for drawing various menus - * and popups, saving the ROM, and managing editor-specific flags. + * and popups, saving the Rom, and managing editor-specific flags. * * The MasterEditor class contains instances of various editor classes such as * AssemblyEditor, DungeonEditor, GraphicsEditor, MusicEditor, OverworldEditor, diff --git a/src/app/editor/modules/gfx_group_editor.h b/src/app/editor/modules/gfx_group_editor.h index 53734284..7c575b6d 100644 --- a/src/app/editor/modules/gfx_group_editor.h +++ b/src/app/editor/modules/gfx_group_editor.h @@ -25,7 +25,7 @@ namespace editor { /** * @class GfxGroupEditor - * @brief Manage graphics group configurations in a ROM. + * @brief Manage graphics group configurations in a Rom. */ class GfxGroupEditor : public SharedRom { public: diff --git a/src/app/editor/modules/music_editor.h b/src/app/editor/modules/music_editor.h index dbf04b9d..579d9089 100644 --- a/src/app/editor/modules/music_editor.h +++ b/src/app/editor/modules/music_editor.h @@ -57,7 +57,7 @@ static constexpr absl::string_view kSongNotes[] = { /** * @class MusicEditor - * @brief A class for editing music data in a ROM. + * @brief A class for editing music data in a Rom. */ class MusicEditor : public SharedRom { public: diff --git a/src/app/editor/overworld_editor.h b/src/app/editor/overworld_editor.h index 513c2dec..9008486f 100644 --- a/src/app/editor/overworld_editor.h +++ b/src/app/editor/overworld_editor.h @@ -64,7 +64,7 @@ constexpr absl::string_view kOWMapTable = "#MapSettingsTable"; /** * @class OverworldEditor - * @brief Manipulates the Overworld and OverworldMap data in a ROM. + * @brief Manipulates the Overworld and OverworldMap data in a Rom. * * The `OverworldEditor` class is responsible for managing the editing and * manipulation of the overworld in a game. The user can drag and drop tiles, @@ -121,7 +121,7 @@ class OverworldEditor : public Editor, /** * @brief Load the Bitmap objects for each OverworldMap. * - * Calls the Overworld class to load the image data and palettes from the ROM, + * Calls the Overworld class to load the image data and palettes from the Rom, * then renders the area graphics and tile16 blockset Bitmap objects before * assembling the OverworldMap Bitmap objects. */ diff --git a/src/app/emu/emulator.h b/src/app/emu/emulator.h index 686f99be..76428138 100644 --- a/src/app/emu/emulator.h +++ b/src/app/emu/emulator.h @@ -20,7 +20,7 @@ namespace emu { /** * @class Emulator - * @brief A class for emulating and debugging SNES ROMs. + * @brief A class for emulating and debugging SNES games. */ class Emulator : public SharedRom { public: diff --git a/src/app/gfx/snes_color.h b/src/app/gfx/snes_color.h index 5450e7e9..5923d27b 100644 --- a/src/app/gfx/snes_color.h +++ b/src/app/gfx/snes_color.h @@ -33,7 +33,7 @@ std::vector Convert(const std::vector& palette); * @brief SNES Color container * * Used for displaying the color to the screen and writing - * the color to the ROM file in the correct format. + * the color to the Rom file in the correct format. * * SNES colors may be represented in one of three formats: * - Color data from the rom in a snes_color struct diff --git a/src/app/rom.h b/src/app/rom.h index 475acf50..54e45f34 100644 --- a/src/app/rom.h +++ b/src/app/rom.h @@ -125,14 +125,14 @@ constexpr uint32_t kFontSpriteLocation = 0x70000; constexpr uint32_t kGfxGroupsPointer = 0x6237; /** - * @brief The ROM class is used to load, save, and modify ROM data. + * @brief The Rom class is used to load, save, and modify Rom data. */ class Rom : public core::ExperimentFlags { public: /** - * @brief Loads 2bpp graphics from ROM data. + * @brief Loads 2bpp graphics from Rom data. * - * This function loads 2bpp graphics from ROM data by iterating over a list of + * This function loads 2bpp graphics from Rom data by iterating over a list of * sheet IDs, decompressing the sheet data, converting it to 8bpp format, and * appending the converted sheet data to a byte vector. * @@ -140,12 +140,12 @@ class Rom : public core::ExperimentFlags { absl::StatusOr Load2BppGraphics(); /** - * @brief Loads the players 4bpp graphics sheet from ROM data. + * @brief Loads the players 4bpp graphics sheet from Rom data. */ absl::Status LoadLinkGraphics(); /** - * @brief This function iterates over all graphics sheets in the ROM and loads + * @brief This function iterates over all graphics sheets in the Rom and loads * them into memory. Depending on the sheet's index, it may be uncompressed or * compressed using the LC-LZ2 algorithm. The uncompressed sheets are 3 bits * per pixel (BPP), while the compressed sheets are 4 BPP. The loaded graphics @@ -176,7 +176,7 @@ class Rom : public core::ExperimentFlags { absl::Status LoadAllPalettes(); /** - * Load ROM data from a file. + * Load Rom data from a file. * * @param filename The name of the file to load. * @param z3_load Whether to load data specific to Zelda 3. @@ -188,10 +188,10 @@ class Rom : public core::ExperimentFlags { absl::Status LoadFromBytes(const Bytes& data); /** - * @brief Saves the ROM data to a file + * @brief Saves the Rom data to a file * * @param backup If true, creates a backup file with timestamp in its name - * @param filename The name of the file to save the ROM data to + * @param filename The name of the file to save the Rom data to * * @return absl::Status Returns an OK status if the save was successful, * otherwise returns an error status @@ -200,7 +200,7 @@ class Rom : public core::ExperimentFlags { std::string filename = ""); /** - * Saves the given palette to the ROM if any of its colors have been modified. + * Saves the given palette to the Rom if any of its colors have been modified. * * @param index The index of the palette to save. * @param group_name The name of the group containing the palette. @@ -210,7 +210,7 @@ class Rom : public core::ExperimentFlags { gfx::SnesPalette& palette); /** - * @brief Saves all palettes in the ROM. + * @brief Saves all palettes in the Rom. * * This function iterates through all palette groups and all palettes in each * group, and saves each palette using the SavePalette() function. @@ -581,7 +581,7 @@ class Rom : public core::ExperimentFlags { } } - bool SaveGroupsToROM() { + bool SaveGroupsToRom() { int gfxPointer = (rom_data_[kGfxGroupsPointer + 1] << 8) + rom_data_[kGfxGroupsPointer]; gfxPointer = core::SnesToPc(gfxPointer); @@ -685,7 +685,7 @@ class Rom : public core::ExperimentFlags { }; /** - * @brief A class to hold a shared pointer to a ROM object. + * @brief A class to hold a shared pointer to a Rom object. */ class SharedRom { public: diff --git a/src/app/zelda3/overworld/overworld_map.cc b/src/app/zelda3/overworld/overworld_map.cc index 42d1c3ae..23870c62 100644 --- a/src/app/zelda3/overworld/overworld_map.cc +++ b/src/app/zelda3/overworld/overworld_map.cc @@ -353,7 +353,7 @@ absl::Status SetColorsPalette(Rom& rom, int index, gfx::SnesPalette& current, } } // namespace palette_internal -// New helper function to get a palette from the ROM. +// New helper function to get a palette from the Rom. absl::StatusOr OverworldMap::GetPalette( const gfx::PaletteGroup& palette_group, int index, int previous_index, int limit) { diff --git a/src/cli/command_handler.h b/src/cli/command_handler.h index 31ab98d8..6bd725be 100644 --- a/src/cli/command_handler.h +++ b/src/cli/command_handler.h @@ -21,7 +21,7 @@ #include "app/gfx/snes_tile.h" #include "app/gui/canvas.h" #include "app/gui/pipeline.h" -#include "app/rom.h" // for ROM +#include "app/rom.h" // for Rom #include "app/zelda3/overworld/overworld.h" #include "cli/patch.h" // for ApplyBpsPatch, CreateBpsPatch @@ -105,7 +105,7 @@ class CreatePatch : public CommandHandler { }; /** - * @brief Open a ROM file and display information about it. + * @brief Open a Rom file and display information about it. */ class Open : public CommandHandler { public: @@ -123,7 +123,7 @@ class Open : public CommandHandler { }; /** - * @brief Backup a ROM file. + * @brief Backup a Rom file. */ class Backup : public CommandHandler { public: @@ -232,7 +232,7 @@ class PcToSnes : public CommandHandler { }; /** - * @brief Read from a ROM file. + * @brief Read from a Rom file. * @param arg_vec `-r
` * @return absl::Status @@ -270,7 +270,7 @@ class ReadFromRom : public CommandHandler { }; /** - * @brief Transfer tile 16 data from one ROM to another. + * @brief Transfer tile 16 data from one Rom to another. * @param arg_vec `-t ""` * @return absl::Status @@ -281,7 +281,7 @@ class Tile16Transfer : public CommandHandler { }; /** - * @brief Expand a ROM file. + * @brief Expand a Rom file. * @param arg_vec `-x ` * @return absl::Status @@ -305,7 +305,7 @@ class Expand : public CommandHandler { }; /** - * @brief Start the emulator on a SNES ROM file. + * @brief Start the emulator on a SNES Rom file. * @param arg_vec `-emu ` * @return absl::Status @@ -371,7 +371,7 @@ struct Commands { {"-s", std::make_shared()}, {"-p", std::make_shared()}, {"-t", std::make_shared()}, - {"-r", std::make_shared()} // Read from ROM + {"-r", std::make_shared()} // Read from Rom }; };