[sikuli] 362/385: starting with Guide javadocs

[Gilles Filippini]

This is an automated email from the git hooks/post-receive script.

pini pushed a commit to tag upstream/1.1.0_beta1
in repository sikuli.

commit a236ea5ab43fe3d4967fe4d597500dbe521806ee
Author: Raimund Hocke <rmhdevelop at me.com>
Date:   Tue Apr 22 08:46:21 2014 +0200

    starting with Guide javadocs
---
 Guide/src/main/java/org/sikuli/guide/SikuliGuide.java | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/Guide/src/main/java/org/sikuli/guide/SikuliGuide.java b/Guide/src/main/java/org/sikuli/guide/SikuliGuide.java
index 81e3ba0..ed69a2f 100644
--- a/Guide/src/main/java/org/sikuli/guide/SikuliGuide.java
+++ b/Guide/src/main/java/org/sikuli/guide/SikuliGuide.java
@@ -35,11 +35,6 @@ public class SikuliGuide extends OverlayTransparentWindow implements EventObserv
   static public final int LAST = 2;
   static public final int SIMPLE = 4;
   final float DIMMING_OPACITY = 0.5f;
-  boolean _debug = false;
-
-  public void setDebug() {
-    _debug = true;
-  }
 
   Robot robot;
   Region _region;
@@ -51,12 +46,18 @@ public class SikuliGuide extends OverlayTransparentWindow implements EventObserv
   ClickableWindow clickableWindow = null;
   SikuliGuideBeam beam = null;
 
+  /**
+   * create a new guide overlay on whole primary screen
+   */
   public SikuliGuide() {
     super(new Color(0.1f, 0f, 0f, 0.1f), null);
     super.addObserver(this);
     init(new Screen());
   }
 
+  /**
+   * create a new guide overlay on given region
+   */
   public SikuliGuide(Region region) {
     super(new Color(0.1f, 0f, 0f, 0.1f), null);
     super.addObserver(this);
@@ -710,6 +711,11 @@ public class SikuliGuide extends OverlayTransparentWindow implements EventObserv
    *
    * }*///</editor-fold>
 
+  /**
+   * create a rectangle in this guide plane and add to front
+   * @return the rectangle
+   */
+  
   public SikuliGuideComponent rectangle() {
     SikuliGuideComponent gc = new SikuliGuideRectangle();
     gc.setGuide(this);

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/sikuli.git