From 1576b4500bb2719bc64cbf91d0e61f0bf9b3f643 Mon Sep 17 00:00:00 2001
From: Thomas Harte <thomas.harte@gmail.com>
Date: Sun, 13 Aug 2017 18:27:00 -0400
Subject: [PATCH] Added documentation.

---
 Storage/Disk/MFMDiskController.hpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Storage/Disk/MFMDiskController.hpp b/Storage/Disk/MFMDiskController.hpp
index d512ff525..4ace6665e 100644
--- a/Storage/Disk/MFMDiskController.hpp
+++ b/Storage/Disk/MFMDiskController.hpp
@@ -107,6 +107,10 @@ class MFMController: public Controller {
 		*/
 		void write_raw_short(uint16_t value);
 
+		/*!
+			Gets the current value of the CRC generator and makes two calls to @c write_byte, to
+			write first its higher-value byte and then its lower.
+		*/
 		void write_crc();
 
 	private: