From bb861b81b2ae5ba54ee3a999db03bfdcf876077d Mon Sep 17 00:00:00 2001
From: Maciej Suminski <maciej.suminski@cern.ch>
Date: Sat, 14 Feb 2015 21:49:06 +0100
Subject: [PATCH] Missing comments in the PLACEMENT_TOOL class.

---
 pcbnew/tools/placement_tool.h | 36 ++++++++++++++++++++++++-----------
 1 file changed, 25 insertions(+), 11 deletions(-)

diff --git a/pcbnew/tools/placement_tool.h b/pcbnew/tools/placement_tool.h
index 0a80dc79fe..75e52fb07c 100644
--- a/pcbnew/tools/placement_tool.h
+++ b/pcbnew/tools/placement_tool.h
@@ -29,10 +29,6 @@
 
 class SELECTION_TOOL;
 
-/**
- * TODO description
- */
-
 class PLACEMENT_TOOL : public TOOL_INTERACTIVE
 {
 public:
@@ -45,26 +41,44 @@ public:
     /// @copydoc TOOL_INTERACTIVE::Init()
     bool Init();
 
-    /// TODO
+    /**
+     * Function AlignTop()
+     * Sets Y coordinate of the selected items to the value of the top-most selected item Y coordinate.
+     */
     int AlignTop( const TOOL_EVENT& aEvent );
 
-    /// TODO
+    /**
+     * Function AlignBottom()
+     * Sets Y coordinate of the selected items to the value of the bottom-most selected item Y coordinate.
+     */
     int AlignBottom( const TOOL_EVENT& aEvent );
 
-    /// TODO
+    /**
+     * Function AlignLeft()
+     * Sets X coordinate of the selected items to the value of the left-most selected item X coordinate.
+     */
     int AlignLeft( const TOOL_EVENT& aEvent );
 
-    /// TODO
+    /**
+     * Function AlignRight()
+     * Sets X coordinate of the selected items to the value of the right-most selected item X coordinate.
+     */
     int AlignRight( const TOOL_EVENT& aEvent );
 
-    /// TODO
+    /**
+     * Function DistributeHorizontally()
+     * Distributes the selected items along the X axis.
+     */
     int DistributeHorizontally( const TOOL_EVENT& aEvent );
 
-    /// TODO
+    /**
+     * Function DistributeVertically()
+     * Distributes the selected items along the Y axis.
+     */
     int DistributeVertically( const TOOL_EVENT& aEvent );
 
 private:
-    /// TODO
+    ///> Sets up handlers for various events.
     void setTransitions();
 
     SELECTION_TOOL* m_selectionTool;