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/tool/icon_tool.rs | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'src/tool/icon_tool.rs')

diff --git a/src/tool/icon_tool.rs b/src/tool/icon_tool.rs
index 09b0ac1..c9e671e 100644
--- a/src/tool/icon_tool.rs
+++ b/src/tool/icon_tool.rs
@@ -1,3 +1,6 @@
+//! Tool for creating icons. For explanation of icons, please see
+//! [the icon module](crate::map::icon).
+
 use crate::button::Button;
 use crate::config::IconToolKeys;
 use crate::map::icon_renderer::IconRenderer;
@@ -8,10 +11,8 @@ use crate::transform::Transform;
 use raylib::core::drawing::RaylibDrawHandle;
 use std::rc::Rc;
 
-pub const ICON_DIR: &str = "assets/icons";
-
+/// The icon tool itself.
 pub struct IconTool {
-    // TODO: support svg
     keybindings: IconToolKeys,
     /// Saves whether the IconTool is the currently active tool or not.
     active: bool,
@@ -22,6 +23,8 @@ pub struct IconTool {
 }
 
 impl IconTool {
+    /// Create a new icon tool that renders icons with the provided icon renderer. There should only
+    /// be one instance of the tool for the program, which should be created in the editor.
     pub fn new(keybindings: IconToolKeys, renderer: Rc<IconRenderer>) -> Self {
         Self {
             keybindings,
-- 
cgit v1.2.3-70-g09d2