6502/CLK
1
0
Fork 0
mirror of https://github.com/TomHarte/CLK.git synced 2024-12-25 18:30:21 +00:00
Code Issues Projects Releases Wiki Activity

Corrects minor documentation errors.

Browse Source
This commit is contained in:
Thomas Harte 2018-04-23 19:59:19 -07:00
parent bce0702745
commit 38b2302b59
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Storage/Disk/DiskImage/Formats/HFE.hpp
View File

@ -18,21 +18,20 @@ namespace Storage {
namespace Disk {
/*!
Provides a @c Disk containing an HFE disk image — a bit stream representation of a floppy.
Provides a @c DiskImage containing an HFE — a bit stream representation of a floppy.
*/
class HFE: public DiskImage {
public:
/*!
Construct an @c SSD containing content from the file with name @c file_name.
Construct an @c HFE containing content from the file with name @c file_name.
@throws ErrorCantOpen if this file can't be opened.
@throws ErrorNotSSD if the file doesn't appear to contain a .SSD format image.
@throws ErrorNotHFE if the file doesn't appear to contain a .SSD format image.
*/
HFE(const std::string &file_name);
~HFE();
enum {
ErrorNotHFE,
ErrorNotHFE
};
// implemented to satisfy @c Disk