src/backup/backup_info.rs: improve docs

diff --git a/src/backup/backup_info.rs b/src/backup/backup_info.rs
index 684f63c05f4ba9cfa9535b8a51adcd88f6981a4f..2aee800b30b8a5b8fa27d12b944775a32c9f01c0 100644 (file)
--- a/src/backup/backup_info.rs
+++ b/src/backup/backup_info.rs
@@ -33,7 +33,7 @@ lazy_static!{
 
 }
 
-/// Group Backups
+/// BackupGroup is a directory containing a list of BackupDir
 #[derive(Debug)]
 pub struct BackupGroup {
     /// Type of backup
@@ -80,6 +80,8 @@ impl BackupGroup {
 }
 
 /// Uniquely identify a Backup (relative to data store)
+///
+/// We also call this a backup snaphost.
 #[derive(Debug)]
 pub struct BackupDir {
     /// Backup group
@@ -123,7 +125,7 @@ impl BackupDir {
     }
 }
 
-/// Detailed Backup Information
+/// Detailed Backup Information, lists files inside a BackupDir
 #[derive(Debug)]
 pub struct BackupInfo {
     /// the backup directory