From cf1403bc791cfa7c6c3c19893c49a6202666bfdc Mon Sep 17 00:00:00 2001
From: Thomas Harte <thomas.harte@gmail.com>
Date: Fri, 11 Aug 2017 14:27:07 -0400
Subject: [PATCH] Increased documentation.

---
 Storage/Disk/Encodings/MFM.hpp | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/Storage/Disk/Encodings/MFM.hpp b/Storage/Disk/Encodings/MFM.hpp
index d1e5b7e15..eed23e5b3 100644
--- a/Storage/Disk/Encodings/MFM.hpp
+++ b/Storage/Disk/Encodings/MFM.hpp
@@ -52,7 +52,22 @@ struct Sector {
 };
 
 extern const size_t DefaultSectorGapLength;
+/*!
+	Converts a vector of sectors into a properly-encoded MFM track.
+
+	@param sectors The sectors to write.
+	@param sector_gap_length If specified, sets the distance in whole bytes between each ID and its data.
+	@param sector_gap_filler_byte If specified, sets the value (unencoded) that is used to populate the gap between each ID and its data.
+*/
 std::shared_ptr<Storage::Disk::Track> GetMFMTrackWithSectors(const std::vector<Sector> &sectors, size_t sector_gap_length = DefaultSectorGapLength, uint8_t sector_gap_filler_byte = 0x4e);
+
+/*!
+	Converts a vector of sectors into a properly-encoded FM track.
+
+	@param sectors The sectors to write.
+	@param sector_gap_length If specified, sets the distance in whole bytes between each ID and its data.
+	@param sector_gap_filler_byte If specified, sets the value (unencoded) that is used to populate the gap between each ID and its data.
+*/
 std::shared_ptr<Storage::Disk::Track> GetFMTrackWithSectors(const std::vector<Sector> &sectors, size_t sector_gap_length = DefaultSectorGapLength, uint8_t sector_gap_filler_byte = 0x4e);
 
 class Encoder {