From c41f17a1261dd1b854b865e495a280cb764b82ab Mon Sep 17 00:00:00 2001
From: Joshua Goins <josh@redstrate.com>
Date: Fri, 22 Sep 2023 17:56:33 -0400
Subject: [PATCH] Improve the lackluster BootData documentation

---
 src/bootdata.rs | 4 +++-
 src/lib.rs      | 2 +-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/bootdata.rs b/src/bootdata.rs
index 0d95625..b75f5ae 100755
--- a/src/bootdata.rs
+++ b/src/bootdata.rs
@@ -6,10 +6,11 @@ use std::path::PathBuf;
 
 use crate::patch::{apply_patch, PatchError};
 
-/// Boot data for FFXIV.
+/// Represents the boot data for FFXIV, which is located under the "boot" directory.
 pub struct BootData {
     path: String,
 
+    /// The current version of the boot data, e.g. "2012.01.01.0000.0000".
     pub version: String,
 }
 
@@ -49,6 +50,7 @@ impl BootData {
         }
     }
 
+    /// Applies the patch to boot data and returns any errors it encounters. This function will not update the version in the BootData struct.
     pub fn apply_patch(&self, patch_path: &str) -> Result<(), PatchError> {
         apply_patch(&self.path, patch_path)
     }
diff --git a/src/lib.rs b/src/lib.rs
index e61e982..d9209ab 100755
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -9,7 +9,7 @@ pub mod gamedata;
 /// Parsing game repositories, such as "ffxiv", "ex1" and their version information.
 pub mod repository;
 
-/// Reading and writing the boot data repository.
+/// Handling and updating data in the "boot" directory, which contains the launcher files.
 pub mod bootdata;
 
 /// Common methods and structures relating to the SqPack data format.