Skip to content

Commit

Permalink
Remove documentation for methods that don't exist yet
Browse files Browse the repository at this point in the history
These are a version 0.2 feature!
  • Loading branch information
saxbophone committed May 5, 2021
1 parent 998dbe1 commit 60e927b
Showing 1 changed file with 0 additions and 48 deletions.
48 changes: 0 additions & 48 deletions wondercard/include/wondercard/MemoryCardSlot.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -64,54 +64,6 @@ namespace com::saxbophone::wondercard {
*/
bool remove_card();

/**
* @brief Reads the entire contents of the inserted card
* @returns Card data contents as array of bytes
* @warning Not Implemented
*/
std::array<Byte, MemoryCard::CARD_SIZE> read_card();

/**
* @brief Writes data from the given span to the entire card
* @param data Data to write to the card
* @warning Not Implemented
*/
void write_card(std::span<Byte, MemoryCard::CARD_SIZE> data);

/**
* @brief Reads the specified block of the inserted card
* @returns Block data contents as array of bytes
* @param index Block to read from
* @warning Not Implemented
*/
std::array<Byte, MemoryCard::BLOCK_SIZE> read_block(std::size_t index);

/**
* @brief Writes data from the given span to the specified block of the
* inserted card.
* @param index Block to write to
* @param data Data to write to the block
* @warning Not Implemented
*/
void write_block(std::size_t index, MemoryCard::Block data);

/**
* @brief Reads the specified sector of the inserted card
* @returns Sector data contents as array of bytes
* @param index Sector to read from
* @warning Not Implemented
*/
std::array<Byte, MemoryCard::SECTOR_SIZE> read_sector(std::size_t index);

/**
* @brief Writes data from the given span to the specified sector of
* the inserted card.
* @param index Sector to write to
* @param data Data to write to the sector
* @warning Not Implemented
*/
void write_sector(std::size_t index, MemoryCard::Sector data);

private:
MemoryCard* _inserted_card;
};
Expand Down

0 comments on commit 60e927b

Please sign in to comment.