Add pub and doc to Lrs

Author: Tristramg

src/lrs.rs

@@ -23,15 +23,25 @@ pub struct LrmHandle(usize);
 #[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)]
 pub struct TraversalHandle(usize);
 
-struct Lrm {
-    scale: LrmScale,
-    reference_traversal: TraversalHandle,
-    traversals: Vec<TraversalHandle>,
+/// Represents an Linear Reference Method (LRM)
+/// It is the combination of one (or more) [`Traversals`] for one [`LrmScale`]
+pub struct Lrm {
+    /// The scale of the LRM
+    pub scale: LrmScale,
+    /// Traversal that is the reference of this LRM
+    pub reference_traversal: TraversalHandle,
+    /// All the traversals where this LRM applies
+    pub traversals: Vec<TraversalHandle>,
 }
 
+/// A traversal is path in the network that ends  [`Curve`]
+/// That traversals can be used for many different [`Lrm`]
 struct Traversal<CurveImpl: Curve> {
+    /// Identifies the traversal
     id: String,
+    /// The geometrical curve of the traversal
     curve: CurveImpl,
+    /// All the [`Lrm`] that use this traversal
     lrms: Vec<LrmHandle>,
 }
 
@@ -251,7 +261,8 @@ pub enum LrsError {
     InvalidArchive,
 }
 
-trait LrsBase {
+/// The basic functions to manipulate the LRS
+pub trait LrsBase {
     /// Returns the [`LrmHandle`] (if it exists) of the [`Lrm`] identified by its `lrm_id`.
     fn get_lrm(&self, lrm_id: &str) -> Option<LrmHandle>;
     /// Returns the [`TraversalHandle`] (if it exists) of the [`Traversal`] identified by its `traversal_id`.