1 files changed, 61 insertions, 5 deletions
diff --git a/ui/src/types/position.rs b/ui/src/types/position.rs
index 277a5ed4..34b89f18 100644
--- a/ui/src/types/position.rs
+++ b/ui/src/types/position.rs
@@ -1,3 +1,24 @@
+/*
+ * meli - ui crate.
+ *
+ * Copyright 2017-2018 Manos Pitsidianakis
+ *
+ * This file is part of meli.
+ *
+ * meli is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * meli is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with meli. If not, see <http://www.gnu.org/licenses/>.
+ */
+
 /*!
   Simple type definitions and macro helper for a (x,y) position on the terminal and the areas they define.
 
@@ -25,30 +46,65 @@ pub fn set_y(p: Pos, new_y: usize) -> Pos {
 }
 
 /// An `Area` consists of two points: the upper left and bottom right corners.
+///
+/// Example:
+/// ```
+/// use ui::position;
+///
+/// let new_area = ((0, 0), (1, 1));
+/// ```
 pub type Area = (Pos, Pos);
 
+/// Get the upper left Position of an area
+///
+/// Example:
+/// ```
+/// use ui::position;
+///
+/// let new_area = ((0, 0), (1, 1));
+/// assert_eq!(upper_left!(new_area), (0, 0));
+/// ```
 #[macro_export]
 macro_rules! upper_left {
     ($a:expr) => {
         $a.0
     };
 }
+
+/// Get the bottom right Position of an area
+///
+/// Example:
+/// ```
+/// use ui::position;
+///
+/// let new_area = ((0, 0), (1, 1));
+/// assert_eq!(bottom_right!(new_area), (1, 1));
+/// ```
 #[macro_export]
 macro_rules! bottom_right {
     ($a:expr) => {
         $a.1
     };
 }
+
+/// Check if area is valid.
+///
+/// Example:
+/// ```
+/// use ui::position;
+///
+/// let valid_area = ((0, 0), (1, 1));
+/// assert!(is_valid_area!(valid_area));
+///
+/// let invalid_area = ((2, 2), (1, 1));
+/// assert!(!is_valid_area!(invalid_area));
+///
 #[macro_export]
 macro_rules! is_valid_area {
     ($a:expr) => {{
         let upper_left = upper_left!($a);
         let bottom_right = bottom_right!($a);
-        if get_y(upper_left) > get_y(bottom_right) || get_x(upper_left) > get_x(bottom_right) {
-            false
-        } else {
-            true
-        }
+        !(get_y(upper_left) > get_y(bottom_right) || get_x(upper_left) > get_x(bottom_right))
     }};
 }