X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Fsixth%2Fe3d%2Fgui%2FTextPointer.java;h=7e2bf74a6ab66282497c65e0590c3e2e33b6e9db;hb=de8fb260a5e99922231b1d0f437916e796ec6ccb;hp=f163627cdf7765aa56a16c29f97bf6f582616085;hpb=197ac1b87328bb5b06ba52d3768af04b2007b087;p=sixth-3d.git

diff --git a/src/main/java/eu/svjatoslav/sixth/e3d/gui/TextPointer.java b/src/main/java/eu/svjatoslav/sixth/e3d/gui/TextPointer.java
index f163627..7e2bf74 100755
--- a/src/main/java/eu/svjatoslav/sixth/e3d/gui/TextPointer.java
+++ b/src/main/java/eu/svjatoslav/sixth/e3d/gui/TextPointer.java
@@ -1,12 +1,12 @@
 /*
  * Sixth 3D engine. Author: Svjatoslav Agejenko. 
  * This project is released under Creative Commons Zero (CC0) license.
- *
-*
  */
-
 package eu.svjatoslav.sixth.e3d.gui;
 
+/**
+ * A pointer to a character in a text.
+ */
 public class TextPointer implements Comparable<TextPointer> {
 
     public int row;
@@ -51,6 +51,15 @@ public class TextPointer implements Comparable<TextPointer> {
 
     }
 
+    /**
+     * Checks if this pointer is between the specified pointers.
+     *
+     * @param start
+     *            The start pointer.
+     * @param end
+     *            The end pointer.
+     * @return True if this pointer is between the specified pointers.
+     */
     public boolean isBetween(final TextPointer start, final TextPointer end) {
 
         if (start == null)
@@ -59,6 +68,7 @@ public class TextPointer implements Comparable<TextPointer> {
         if (end == null)
             return false;
 
+        // Make sure that start is smaller than end.
         TextPointer smaller;
         TextPointer bigger;
 
@@ -70,8 +80,8 @@ public class TextPointer implements Comparable<TextPointer> {
             bigger = start;
         }
 
+        // Check if this pointer is between the specified pointers.
         return (compareTo(smaller) >= 0) && (bigger.compareTo(this) > 0);
-
     }
 
 }