add some documentation to structs

1 files changed, 4 insertions, 0 deletions

diff --git a/src/dictionary.rs b/src/dictionary.rs
index e0a561a..94f377d 100644
--- a/src/dictionary.rs
+++ b/src/dictionary.rs
@@ -1,6 +1,10 @@
 use std::collections::HashMap;
 use crate::vector::FileVector;
 
+/// The dictionary is used to cache to words ids.
+/// It also provides a function to convert it to
+/// a vector and generate a FileVector from a word list
+/// with the current directory.
 pub struct Dictionary {
     last_index : usize,
     data : HashMap<String, u64>,