Fixed documentation

src/edge.rs

@@ -6,6 +6,7 @@ use std::hash::Hasher;
 use std::hash::Hash;
 
 #[derive(Clone, Debug)]
+/// Edge internal struct
 pub struct Edge {
     inbound: Arc<VertexId>,
     outbound: Arc<VertexId>,

src/graph.rs

@@ -7,12 +7,14 @@ use hashbrown::{HashMap, HashSet};
 use std::sync::Arc;
 
 #[derive(Clone, Debug, PartialEq)]
+/// Graph operation error
 pub enum GraphErr {
     NoSuchVertex,
     CannotAddEdge,
 }
 
 #[derive(Clone, Debug)]
+/// Graph data-structure
 pub struct Graph<T> {
     vertices: HashMap<Arc<VertexId>, (T, Arc<VertexId>)>,
     edges: HashSet<Edge>,

src/iterators/bfs.rs

@@ -8,6 +8,7 @@ use std::collections::VecDeque;
 use std::sync::Arc;
 
 #[derive(Debug)]
+/// Breadth-First Iterator
 pub struct Bfs<'a, T> {
     queue: VecDeque<Arc<VertexId>>,
     current_ptr: Option<Arc<VertexId>>,

src/iterators/dfs.rs

@@ -7,6 +7,7 @@ use hashbrown::HashMap;
 use std::sync::Arc;
 
 #[derive(Debug)]
+/// Depth-First Iterator
 pub struct Dfs<'a, T> {
     recursion_stack: Vec<Arc<VertexId>>,
     color_map: HashMap<Arc<VertexId>, Color>,

src/iterators/vertices.rs

@@ -3,6 +3,7 @@
 use crate::vertex_id::VertexId;
 
 #[derive(Debug)]
+/// Generic Vertex Iterator
 pub struct VertexIter<'a> {
     current: usize,
     iterable: Vec<&'a VertexId>,

src/macros.rs

@@ -1,4 +1,4 @@
-/// macro to find minimum of a number
+/// Find the minimum of a set of numbers
 #[macro_export]
 macro_rules! min {
     ($x: expr) => ($x);

src/vertex_id.rs

@@ -3,6 +3,7 @@
 use rand::Rng;
 
 #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
+/// Id of a vertex
 pub struct VertexId([u8; 16]); // 128bit
 
 impl VertexId {