From 8508c53befdf0e0ef81e820a9a5f7256f8e0186c Mon Sep 17 00:00:00 2001
From: mhart <martin-hart@protonmail.com>
Date: Sat, 17 Oct 2020 18:16:40 +0200
Subject: [PATCH] Add documentation to main.rs

---
 src/main.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/main.rs b/src/main.rs
index 48fdae4..f13144f 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,17 +1,21 @@
 use std::fs;
 use std::io;
 
+/// Struct to store robot position
 struct Position {
     x: u32,
     y: u32,
 }
 
+/// A Robot *aka droid* is represented here.
+/// Each robot must have a unique id.
 struct Robot {
     id: u32,
     o: Orientation,
     p: Position,
 }
 
+/// Enum to store all possible orientations.
 enum Orientation {
     N,
     E,
@@ -19,12 +23,14 @@ enum Orientation {
     W,
 }
 
+/// Enum to store all possible instructions.
 enum Instruction {
     L,
     R,
     F,
 }
 
+/// Parse char and return corresponding orientation.
 fn parse_orientation(c: char) -> Result<Orientation, &'static str> {
     match c {
         'N' => Ok(Orientation::N),
@@ -35,6 +41,7 @@ fn parse_orientation(c: char) -> Result<Orientation, &'static str> {
     }
 }
 
+/// Parse char and return corresponding instruction.
 fn parse_instruction(c: char) -> Result<Instruction, &'static str> {
     match c {
         'L' => Ok(Instruction::L),
@@ -44,6 +51,7 @@ fn parse_instruction(c: char) -> Result<Instruction, &'static str> {
     }
 }
 
+/// Retrieve the content of a file and return it as a string.
 fn open_file(filename: &str) -> io::Result<String> {
     let content = fs::read_to_string(filename)?;
     Ok(content)