From d7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4 Mon Sep 17 00:00:00 2001
From: Arne Dußin
Date: Mon, 21 Dec 2020 01:22:15 +0100
Subject: Add previously missing docs where appropriate

---
 src/colours.rs | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'src/colours.rs')

diff --git a/src/colours.rs b/src/colours.rs
index bafb53c..4a3b799 100644
--- a/src/colours.rs
+++ b/src/colours.rs
@@ -1,20 +1,40 @@
+//! The colour definitions used for items drawn in graf karto.
+
 use raylib::ffi::Color;
 
+/// Contains the default colours used throughout, if nothing else is set.
 pub const DEFAULT_COLOURS: Colours = Colours::default();
 
+/// All the different colours that may be used for different elements of the program. Contains one
+/// entry for each colourable component.
 pub struct Colours {
+    /// Colour the rectangle used for the deletion tool is filled with.
     pub deletion_rect: Color,
+    /// The colour of the outline of the deletion tool rectangle.
     pub deletion_rect_outline: Color,
+    /// The colour that is used for filling the selection tool's rectangle.
     pub selection_rect: Color,
+    /// Colour of the selection tool rectangle outline.
     pub selection_rect_outline: Color,
+    /// Colour of the rooms that are currently not selected.
     pub room_normal: Color,
+    /// The Colour the rooms should be tinted in when they have been selected.
     pub room_selected: Color,
+    /// Colour of the walls when they are not selected.
     pub wall_normal: Color,
+    /// Colour of the walls when they have been selected.
     pub wall_selected: Color,
+    /// Colour of the icons when they are not selected.
     pub icon_normal: Color,
+    /// Colour of the icons when they are selected.
     pub icon_selected: Color,
+    /// Colour used to draw the rulers (the ruling lines) of the dimension indicator.
     pub dimension_indicators: Color,
+    /// Colour of the text used to display the size of the dimension indicators dimensions.
     pub dimension_text: Color,
+    /// The colour used for drawing the lines of the grid which divides the map into chunks of evenly
+    /// spaced cells.
+    pub grid_lines: Color,
 }
 
 impl Colours {
@@ -95,6 +115,12 @@ impl Colours {
                 b: 200,
                 a: 255,
             },
+            grid_lines: Color {
+                r: 255,
+                g: 255,
+                b: 255,
+                a: 75,
+            },
         }
     }
 }
-- 
cgit v1.2.3-70-g09d2