From 9b4aa4e9643b0a5b4a554e455eac269a2472b590 Mon Sep 17 00:00:00 2001 From: Nathan Reiner Date: Thu, 6 Jul 2023 14:20:14 +0200 Subject: add some documentation to structs --- src/dictionary.rs | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src/dictionary.rs') 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, -- cgit v1.2.3-70-g09d2