add doc

Author: louisgreiner

src/geometry_from_osm.rs

@@ -37,20 +37,20 @@ struct Args {
     lrm_tag: String,
 }
 
-// When sortir the edges, we test each candidate to see if they match and if they need to bee reversed
+// When sorting the edges, each candidate is tested to see if they match and if they need to be reversed.
 #[derive(PartialEq, Eq, Debug)]
 enum Candidate {
     Source,
     Target,
     NotCandidate,
 }
 
-// If we have a string of edges that ends with `end_edge`
-// Can the candidate Edge(s, t) be joined at the end_edge(source, target)
-// Returns Forward if the Edge’s can be appened in the same direction (target == s)
-// Backward if it must be reverded (target == t)
-// And NotCandidate if it can’t be appended
-// consider_source means that we consider the source (or target if false) of the last_edge
+// If we have a string of edges that ends with `end_edge`,
+// the candidate `Edge(s, t)` can be joined at the `end_edge(source, target)`.
+// Returns Forward if the `Edge` can be append in the same direction `(target == s)`,
+// Backward if it must be reversed `(target == t)` or
+// And NotCandidate if it can’t be appended.
+// `consider_source` means that the source (or target if false) of the `last_edge` is considered.
 fn can_be_appended(candidate: &Edge, last_edge: &Edge, consider_source: bool) -> Candidate {
     let last_node = if consider_source {
         last_edge.source
@@ -137,6 +137,9 @@ fn sort_edges(edges: Vec<Edge>, traversal_ref: &str) -> Vec<(Edge, bool)> {
     return sorted;
 }
 
+/// Example: to generate an LRS from an OpenStreetMap dump
+/// 
+/// `$ cargo run --release --bin geometry_from_osm -- -i france.osm.pbf  -o osm_83000.lrs.bin --lrm-tag=ref:fr:SNCF_Reseau`
 fn main() {
     let cli_args = Args::parse();
     let (nodes, edges) = read_osm(&cli_args.input_osm_file, &cli_args.lrm_tag);