From f601d796f5b0818cce937a4ba2846512bf070351 Mon Sep 17 00:00:00 2001 From: Thomas Harte Date: Sat, 24 Dec 2016 22:37:20 -0500 Subject: [PATCH] Added documentation. --- Storage/Disk/Drive.hpp | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/Storage/Disk/Drive.hpp b/Storage/Disk/Drive.hpp index aeeaf95ab..1506e8a2c 100644 --- a/Storage/Disk/Drive.hpp +++ b/Storage/Disk/Drive.hpp @@ -35,18 +35,29 @@ class Drive { bool get_is_track_zero(); /*! - Steps the disk head the specified number of tracks. Positive numbers step inwards, negative numbers - step outwards. + Steps the disk head the specified number of tracks. Positive numbers step inwards (i.e. away from track 0), + negative numbers step outwards (i.e. towards track 0). */ void step(int direction); /*! + Sets the current read head. */ void set_head(unsigned int head); + /*! + @returns @c true if the inserted disk is read-only; @c false otherwise. + */ bool get_is_read_only(); + /*! + @returns the track underneath the current head at the location now stepped to. + */ std::shared_ptr get_track(); + + /*! + Attempts to set @c track as the track underneath the current head at the location now stepped to. + */ void set_track(const std::shared_ptr &track); private: