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 46b30d73e4d072bb8276d81629a9d318277df498 Author: Raimund Hocke <[email protected]> Date: Thu Apr 10 17:40:44 2014 +0200 working on javadocs --- API/src/main/java/org/sikuli/script/App.java | 4 ++-- API/src/main/java/org/sikuli/script/Image.java | 20 ++++++++-------- API/src/main/java/org/sikuli/script/ImagePath.java | 4 ++-- API/src/main/java/org/sikuli/script/Key.java | 2 +- API/src/main/java/org/sikuli/script/Location.java | 2 +- API/src/main/java/org/sikuli/script/Match.java | 5 ++-- .../main/java/org/sikuli/script/ObserveEvent.java | 11 +++++---- .../java/org/sikuli/script/ObserverCallBack.java | 27 +++++++++++----------- createJavadocs | 18 +++++++++++++++ createJavadocsClasses | 10 ++++++++ 10 files changed, 67 insertions(+), 36 deletions(-) diff --git a/API/src/main/java/org/sikuli/script/App.java b/API/src/main/java/org/sikuli/script/App.java index bcab5a1..a44856f 100755 --- a/API/src/main/java/org/sikuli/script/App.java +++ b/API/src/main/java/org/sikuli/script/App.java @@ -26,10 +26,10 @@ import org.sikuli.natives.OSUtil; import org.sikuli.natives.SysUtil; /** - * App implements features to manage (open, switch to, close) applications + * App implements features to manage (open, switch to, close) applications. * on the system we are running on and * to access their assets like windows - * + * <br> * TAKE CARE: function behavior differs depending on the running system * (cosult the docs for more info) */ diff --git a/API/src/main/java/org/sikuli/script/Image.java b/API/src/main/java/org/sikuli/script/Image.java index 7c5bd9d..8cf2a74 100644 --- a/API/src/main/java/org/sikuli/script/Image.java +++ b/API/src/main/java/org/sikuli/script/Image.java @@ -39,10 +39,10 @@ import org.sikuli.basics.Settings; import org.sikuli.natives.Vision; /** - * This class hides the complexity behind image names given as string.<br> - * Its companion is ImagePath that maintains a list of places, where images are + * This class hides the complexity behind image names given as string. + * <br>It's companion is {@link ImagePath} that maintains a list of places, where images are * stored.<br> - * Another companion (ImageGroup) will allow to look at images in a folder as a + * Another companion {@link ImageGroup} will allow to look at images in a folder as a * group.<br> * An Image object:<br> * - has a name, either given or taken from the basename<br> @@ -325,7 +325,7 @@ public class Image { } return createImageValidate(img); } - + public static Image createFromObject(Object obj) { if (obj instanceof String) { return create((String) obj); @@ -335,18 +335,18 @@ public class Image { return new Image((Pattern) obj); } return new Image(); - } - + } + private Image(Pattern p) { pattern = p; imageIsPattern = true; setLastSeen(p.getImage().getLastSeen(), p.getImage().getLastSeenScore()); } - + public Pattern getPattern() { return pattern; } - + public Image getImage() { if (isValid()) { return this; @@ -355,7 +355,7 @@ public class Image { return pattern.getImage(); } return null; - } + } protected static Image get(URL imgURL) { return imageFiles.get(imgURL); @@ -559,7 +559,7 @@ public class Image { public boolean isValid() { return filepath != null; } - + public boolean isUseable() { return isValid() || imageIsPattern; } diff --git a/API/src/main/java/org/sikuli/script/ImagePath.java b/API/src/main/java/org/sikuli/script/ImagePath.java index 5dd93d6..89c2a82 100644 --- a/API/src/main/java/org/sikuli/script/ImagePath.java +++ b/API/src/main/java/org/sikuli/script/ImagePath.java @@ -22,8 +22,8 @@ import org.sikuli.basics.Settings; import org.sikuli.basics.SikuliScript; /** - * maintain the path list of locations, where images will be searched<br> - * the first entry always is the bundlepath used on the scripting level<br> + * maintain the path list of locations, where images will be searched. + * <br>the first entry always is the bundlepath used on the scripting level<br> * Python import automatically adds a sikuli bundle here<br> * supported locations:<br> * - absolute filesystem paths<br> diff --git a/API/src/main/java/org/sikuli/script/Key.java b/API/src/main/java/org/sikuli/script/Key.java index e07df43..13f35d6 100755 --- a/API/src/main/java/org/sikuli/script/Key.java +++ b/API/src/main/java/org/sikuli/script/Key.java @@ -22,7 +22,7 @@ import org.sikuli.basics.Settings; /** * this class implements an interface to the Java key system - * as represented by java.awt.event.KeyEvent + * as represented by java.awt.event.KeyEvent. * for the functions Region.type() and Region.write() * by translating key constants for special keys and plain text per character.<br /> * for details consult the docs diff --git a/API/src/main/java/org/sikuli/script/Location.java b/API/src/main/java/org/sikuli/script/Location.java index f1ad9ad..a0b156d 100755 --- a/API/src/main/java/org/sikuli/script/Location.java +++ b/API/src/main/java/org/sikuli/script/Location.java @@ -12,7 +12,7 @@ import java.awt.Point; import java.awt.Rectangle; /** - * A point like AWT.Point using global coordinates (x, y), + * A point like AWT.Point using global coordinates (x, y). * hence modifications might move location out of * any screen (not checked as is done with region) * diff --git a/API/src/main/java/org/sikuli/script/Match.java b/API/src/main/java/org/sikuli/script/Match.java index aef3398..92f648d 100755 --- a/API/src/main/java/org/sikuli/script/Match.java +++ b/API/src/main/java/org/sikuli/script/Match.java @@ -12,9 +12,10 @@ import org.sikuli.natives.FindResult; /** * holds the result of a find operation, is itself the region on the screen, - * where the image was found and hence inherits all methods from Region<br> + * where the image was found and hence inherits all methods from {@link Region}. + * <br> * attributes:<br> the match score (0 ... 1.0)<br> the click target (e.g. - * from Pattern)<br> a ref to the image used for search<br>or the text used for + * from {@link Pattern})<br> a ref to the image used for search<br>or the text used for * find text<br />and elapsed times for debugging */ public class Match extends Region implements Comparable<Match> { diff --git a/API/src/main/java/org/sikuli/script/ObserveEvent.java b/API/src/main/java/org/sikuli/script/ObserveEvent.java index 58abe58..4b375f9 100755 --- a/API/src/main/java/org/sikuli/script/ObserveEvent.java +++ b/API/src/main/java/org/sikuli/script/ObserveEvent.java @@ -9,6 +9,9 @@ package org.sikuli.script; import java.util.ArrayList; import java.util.List; +/** + * provides information about the observed event being in the {@link ObserverCallBack} + */ public class ObserveEvent { public enum Type { @@ -30,7 +33,7 @@ public class ObserveEvent { protected ObserveEvent() { } - + /** * INTERNAL USE ONLY: creates an observed event */ @@ -46,7 +49,7 @@ public class ObserveEvent { setPattern(ptn); time = now; } - + /** * * @return the observer name of this event @@ -124,7 +127,7 @@ public class ObserveEvent { } } } - + public long getTime() { return time; } @@ -171,7 +174,7 @@ public class ObserveEvent { @Override public String toString() { if (type == Type.CHANGE) { - return String.format("Event(%s) %s on: %s with: %d count: %d", + return String.format("Event(%s) %s on: %s with: %d count: %d", type, name, region, index, getCount()); } else { return String.format("Event(%s) %s on: %s with: %s match: %s count: %d", diff --git a/API/src/main/java/org/sikuli/script/ObserverCallBack.java b/API/src/main/java/org/sikuli/script/ObserverCallBack.java index c328a73..2160440 100644 --- a/API/src/main/java/org/sikuli/script/ObserverCallBack.java +++ b/API/src/main/java/org/sikuli/script/ObserverCallBack.java @@ -9,22 +9,21 @@ package org.sikuli.script; import java.util.EventListener; /** - * - * Use this class to implement call back methods for the Region observers <br> - * onAppear, onVanish and onChange <br> + * Use this class to implement call back methods for the Region observers + * onAppear, onVanish and onChange. <br> * by overriding the contained empty methods appeared, vanished and changed - * - * example:<br> - * aRegion.onAppear(anImage, <br> - new ObservingCallBack() { <br> - * <br> - appeared(ObserveEvent e) { <br> - // do something - } - } - ); + * <pre> + * example: + * aRegion.onAppear(anImage, + * new ObservingCallBack() { + * appeared(ObserveEvent e) { + * // do something + * } + * } + * ); + * </pre> when the image appears, your above call back appeared() will be called - see ObserveEvent about the features available in the callback function + see {@link ObserveEvent} about the features available in the callback function */ public class ObserverCallBack implements EventListener { diff --git a/createJavadocs b/createJavadocs new file mode 100755 index 0000000..79b6fbf --- /dev/null +++ b/createJavadocs @@ -0,0 +1,18 @@ +#!/bin/sh +# creates the javadocs for selected classes and their public members +apijar=API/target/SikuliX-API-1.1.0.jar +basicsjar=Basics/target/SikuliX-Basics-1.1.0.jar +nativesjar=Natives/target/SikuliX-Natives-1.1.0.jar +opencvjar=OpenCV4Sikulix/target/OpenCV4Sikulix-2.4.7.jar +apisrc=API/src/main/java/org/sikuli/script +echo $apisrc/Region.java >createJavadocsClasses +echo $apisrc/Match.java >>createJavadocsClasses +echo $apisrc/Screen.java >>createJavadocsClasses +echo $apisrc/Pattern.java >>createJavadocsClasses +echo $apisrc/Location.java >>createJavadocsClasses +echo $apisrc/Image.java >>createJavadocsClasses +echo $apisrc/ImagePath.java >>createJavadocsClasses +echo $apisrc/Key.java >>createJavadocsClasses +echo $apisrc/ObserverCallBack.java >>createJavadocsClasses +echo $apisrc/ObserveEvent.java >>createJavadocsClasses +javadoc -public -classpath $apijar:$basicsjar:$nativesjar:$opencvjar -d target/docs @createJavadocsClasses diff --git a/createJavadocsClasses b/createJavadocsClasses new file mode 100644 index 0000000..a6f921d --- /dev/null +++ b/createJavadocsClasses @@ -0,0 +1,10 @@ +API/src/main/java/org/sikuli/script/Region.java +API/src/main/java/org/sikuli/script/Match.java +API/src/main/java/org/sikuli/script/Screen.java +API/src/main/java/org/sikuli/script/Pattern.java +API/src/main/java/org/sikuli/script/Location.java +API/src/main/java/org/sikuli/script/Image.java +API/src/main/java/org/sikuli/script/ImagePath.java +API/src/main/java/org/sikuli/script/Key.java +API/src/main/java/org/sikuli/script/ObserverCallBack.java +API/src/main/java/org/sikuli/script/ObserveEvent.java -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/sikuli.git _______________________________________________ pkg-java-commits mailing list [email protected] http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-java-commits
