[sikuli] 103/385: Fixed Javadoc errors that made it impossible to build javadoc jar (maybe only under jdk8). Especially problematic was error "self-closing element not allowed" for "<br />" tags (should be "<br>").
Gilles Filippini
pini at moszumanska.debian.org
Sun Jun 29 19:25:55 UTC 2014
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 a635294801e398bd5e883c921d7ee7efe9615303
Author: Ireneusz Matysiewicz <iirekm at gmail.com>
Date: Sat Jan 4 20:46:58 2014 +0100
Fixed Javadoc errors that made it impossible to build javadoc jar (maybe only under jdk8).
Especially problematic was error "self-closing element not allowed" for "<br />" tags (should be "<br>").
---
API/src/main/java/org/sikuli/script/Finder.java | 4 +-
API/src/main/java/org/sikuli/script/Image.java | 59 +++--
.../main/java/org/sikuli/script/ImageGroup.java | 14 +-
.../main/java/org/sikuli/script/ImageLocator.java | 72 +++---
API/src/main/java/org/sikuli/script/ImagePath.java | 2 +-
API/src/main/java/org/sikuli/script/Location.java | 24 +-
API/src/main/java/org/sikuli/script/Match.java | 8 +-
API/src/main/java/org/sikuli/script/Mouse.java | 46 ++--
API/src/main/java/org/sikuli/script/Observer.java | 20 +-
.../java/org/sikuli/script/ObserverCallBack.java | 14 +-
API/src/main/java/org/sikuli/script/Pattern.java | 14 +-
API/src/main/java/org/sikuli/script/Region.java | 270 ++++++++++-----------
API/src/main/java/org/sikuli/script/Screen.java | 8 +-
.../main/java/org/sikuli/script/ScreenImage.java | 3 -
Basics/src/main/java/org/sikuli/basics/Debug.java | 40 +--
.../main/java/org/sikuli/basics/FileManager.java | 23 +-
.../main/java/org/sikuli/basics/GifDecoder.java | 6 +-
.../main/java/org/sikuli/basics/IScriptRunner.java | 1 -
.../java/org/sikuli/basics/ResourceLoader.java | 2 -
.../src/main/java/org/sikuli/basics/Settings.java | 38 +--
.../src/main/java/org/sikuli/basics/SikuliX.java | 14 +-
.../java/org/sikuli/basics/SikuliXforJython.java | 6 +-
.../main/java/org/sikuli/guide/ComponentMover.java | 6 +-
.../org/sikuli/guide/SikuliGuideComponent.java | 4 +-
IDE/pom.xml | 7 +
.../java/org/sikuli/jython/PythonIndentation.java | 2 +-
.../main/java/org/sikuli/jython/PythonState.java | 4 +-
27 files changed, 351 insertions(+), 360 deletions(-)
diff --git a/API/src/main/java/org/sikuli/script/Finder.java b/API/src/main/java/org/sikuli/script/Finder.java
index a62ca98..259ab07 100755
--- a/API/src/main/java/org/sikuli/script/Finder.java
+++ b/API/src/main/java/org/sikuli/script/Finder.java
@@ -40,7 +40,7 @@ public class Finder implements Iterator<Match> {
/**
* Finder constructor (finding within an image).
- * <br />internally used with a screen snapshot
+ * <br>internally used with a screen snapshot
*
* @param imageFilename a string (name, path, url)
*/
@@ -50,7 +50,7 @@ public class Finder implements Iterator<Match> {
/**
* Finder constructor (finding within an image within the given region).
- * <br />internally used with a screen snapshot
+ * <br>internally used with a screen snapshot
*
* @param imageFilename a string (name, path, url)
* @param region search Region within image - topleft = (0,0)
diff --git a/API/src/main/java/org/sikuli/script/Image.java b/API/src/main/java/org/sikuli/script/Image.java
index b0d8fdb..a485043 100644
--- a/API/src/main/java/org/sikuli/script/Image.java
+++ b/API/src/main/java/org/sikuli/script/Image.java
@@ -37,20 +37,20 @@ 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 stored.<br />
- * Another companion is ImageGroup allowing to 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 without ending.<br />
- * - keeps its in memory buffered image in a configurable cache avoiding reload from source<br />
- * - remembers, where it was found the last time searched<br />
- * - can be sourced from the filesystem, from jars, from the web and from other in memory images <br />
- * - it will have features for basic image manipulation <br />
- * - it contains the stuff to communicate with the underlying OpenCV based search engine <br />
+ * 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 stored.<br>
+ * Another companion is ImageGroup allowing to 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 without ending.<br>
+ * - keeps its in memory buffered image in a configurable cache avoiding reload from source<br>
+ * - remembers, where it was found the last time searched<br>
+ * - can be sourced from the filesystem, from jars, from the web and from other in memory images <br>
+ * - it will have features for basic image manipulation <br>
+ * - it contains the stuff to communicate with the underlying OpenCV based search engine <br>
*
- * This class maintains<br />
- * - a list of all images loaded with there source reference and a ref to the image object<br />
- * - a list of all images currently storing their in memory buffered image (managed as a cache)<br />
+ * This class maintains<br>
+ * - a list of all images loaded with there source reference and a ref to the image object<br>
+ * - a list of all images currently storing their in memory buffered image (managed as a cache)<br>
*
*/
public class Image {
@@ -111,9 +111,9 @@ public class Image {
}
/**
- * create a new image from a filename <br />
- * file ending .png is added if missing <br />
- * filename: [...path.../]name[.png] is searched on current image path and loaded to cache <br />
+ * create a new image from a filename <br>
+ * file ending .png is added if missing <br>
+ * filename: [...path.../]name[.png] is searched on current image path and loaded to cache <br>
* already loaded image with same name is reused (reference) and taken from cache
* @param imgName
* @return the image
@@ -127,12 +127,11 @@ public class Image {
}
/**
- * create a new image from the given url <br />
- * file ending .png is added if missing <br />
- * filename: ...url-path.../name[.png] is loaded from the url and and cached <br />
+ * create a new image from the given url <br>
+ * file ending .png is added if missing <br>
+ * filename: ...url-path.../name[.png] is loaded from the url and and cached <br>
* already loaded image with same url is reused (reference) and taken from cache
*
- * @param imgName
* @return the image
*/
public static Image create(URL url) {
@@ -144,7 +143,7 @@ public class Image {
}
/**
- * create a new image from a buffered image<br />
+ * create a new image from a buffered image<br>
* can only be reused with the object reference
*
* @param img
@@ -154,8 +153,8 @@ public class Image {
}
/**
- * create a new image from a buffered image<br />
- * giving it a descriptive name for printout and logging <br />
+ * create a new image from a buffered image<br>
+ * giving it a descriptive name for printout and logging <br>
* can only be reused with the object reference
*
* @param img
@@ -174,7 +173,7 @@ public class Image {
}
/**
- * create a new image from a Sikuli ScreenImage (captured)<br />
+ * create a new image from a Sikuli ScreenImage (captured)<br>
* can only be reused with the object reference
*
* @param img
@@ -184,8 +183,8 @@ public class Image {
}
/**
- * create a new image from a Sikuli ScreenImage (captured)<br />
- * giving it a descriptive name for printout and logging <br />
+ * create a new image from a Sikuli ScreenImage (captured)<br>
+ * giving it a descriptive name for printout and logging <br>
* can only be reused with the object reference
*
* @param img
@@ -533,7 +532,7 @@ public class Image {
}
/**
- * store info: this image is divided vertically into n even rows <br />
+ * store info: this image is divided vertically into n even rows <br>
* a preparation for using getRow()
* @param n
* @return the top row
@@ -543,7 +542,7 @@ public class Image {
}
/**
- * store info: this image is divided horizontally into n even columns <br />
+ * store info: this image is divided horizontally into n even columns <br>
* a preparation for using getCol()
* @param n
* @return the leftmost column
@@ -585,7 +584,7 @@ public class Image {
}
/**
- * store info: this image is divided into a raster of even cells <br />
+ * store info: this image is divided into a raster of even cells <br>
* a preparation for using getCell()
* @param r
* @param c
@@ -644,7 +643,7 @@ public class Image {
}
/**
- * get the specified cell counting from (0, 0), if a raster is setup <br />
+ * get the specified cell counting from (0, 0), if a raster is setup <br>
* negative counts reverse from the end (last = -1)
* values outside range are 0 or last respectively
* @param c
diff --git a/API/src/main/java/org/sikuli/script/ImageGroup.java b/API/src/main/java/org/sikuli/script/ImageGroup.java
index 2e235fe..f329df1 100644
--- a/API/src/main/java/org/sikuli/script/ImageGroup.java
+++ b/API/src/main/java/org/sikuli/script/ImageGroup.java
@@ -14,13 +14,13 @@ import java.util.Map;
/**
- * An ImageGroup object represents images, that are all in the same folder.<br />
- * the folder can contain a set of sub folders that can be switched dynamically <br />
- * The folder will be found on the image path.<br />
- * The match data of the images can be stored and reloaded.<br />
- * Its main purpose is to support image sets for different environments.<br />
- * At runtime you can switch between image sets without changing the used image names.<br />
- * Based on the stored match data you might produce a new ImageGroup on the fly.<br />
+ * An ImageGroup object represents images, that are all in the same folder.<br>
+ * the folder can contain a set of sub folders that can be switched dynamically <br>
+ * The folder will be found on the image path.<br>
+ * The match data of the images can be stored and reloaded.<br>
+ * Its main purpose is to support image sets for different environments.<br>
+ * At runtime you can switch between image sets without changing the used image names.<br>
+ * Based on the stored match data you might produce a new ImageGroup on the fly.<br>
*/
public class ImageGroup {
diff --git a/API/src/main/java/org/sikuli/script/ImageLocator.java b/API/src/main/java/org/sikuli/script/ImageLocator.java
index 50b360a..c02fd8c 100755
--- a/API/src/main/java/org/sikuli/script/ImageLocator.java
+++ b/API/src/main/java/org/sikuli/script/ImageLocator.java
@@ -22,8 +22,8 @@ import org.sikuli.basics.FileManager;
import org.sikuli.basics.Settings;
/**
- * This class is currently used to locate image files in the filesystem <br />
- * and in the internet (the files are cached locally) <br />
+ * This class is currently used to locate image files in the filesystem <br>
+ * and in the internet (the files are cached locally) <br>
*
* @deprecated will completely replaced by the classes Image and ImagePath
*/
@@ -100,10 +100,10 @@ public class ImageLocator {
}
/**
- * list entries might be a file path or an url (http/https) <br />list[0]
- * current bundlepath (Settings.BundlePath) (might be null) <br />list[1:n]
- * path's from -DSIKULI_IMAGE_PATH=... <br />list[n+1:] path's added later
- * <br />each path is contained only once <br />each contained file path
+ * list entries might be a file path or an url (http/https) <br>list[0]
+ * current bundlepath (Settings.BundlePath) (might be null) <br>list[1:n]
+ * path's from -DSIKULI_IMAGE_PATH=... <br>list[n+1:] path's added later
+ * <br>each path is contained only once <br>each contained file path
* existed at the time it was added
*
* @return list of absolute path strings (a path might not exist any more)
@@ -149,12 +149,12 @@ public class ImageLocator {
}
/**
- * the given path(s) <br />- might be a file path or an url (http/https) <br
- * />- if file path relative: make absolute path based on current working
- * directory <br />- is(are) first removed from the list <br />- and then
+ * the given path(s) <br>- might be a file path or an url (http/https) <br>
+ * - if file path relative: make absolute path based on current working
+ * directory <br>- is(are) first removed from the list <br>- and then
* added to the end of the list (file path: if it exists)
*
- * @param path absolute or relative path or url <br />might be a path list
+ * @param path absolute or relative path or url <br>might be a path list
* string with seperator : (or ; Windows)
*/
public static String addImagePath(String path) {
@@ -162,13 +162,13 @@ public class ImageLocator {
}
/**
- * the given path(s) <br />- might be a file path or an url (http/https) <br
- * />- if file path relative: make absolute path based on current working
- * directory <br />- is(are) first removed from the list <br />- and then
- * added to the beginning of the list (file path: if it exists) <br />as
+ * the given path(s) <br>- might be a file path or an url (http/https) <br>
+ * - if file path relative: make absolute path based on current working
+ * directory <br>- is(are) first removed from the list <br>- and then
+ * added to the beginning of the list (file path: if it exists) <br>as
* entry 1 after the current bundlepath (entry 0)
*
- * @param path absolute or relative path or url <br />might be a path list
+ * @param path absolute or relative path or url <br>might be a path list
* string with seperator : (or ; Windows)
*/
public static String addImagePathFirst(String path) {
@@ -176,9 +176,9 @@ public class ImageLocator {
}
/**
- * the given paths <br />- might be a file path or an url (http/https) <br
- * />- if file path relative: make absolute path based on current working
- * directory <br />- are removed from the list <br />- and then added to the
+ * the given paths <br>- might be a file path or an url (http/https) <br>
+ * - if file path relative: make absolute path based on current working
+ * directory <br>- are removed from the list <br>- and then added to the
* end of the list (file path: if it exists)
*
* @param pl absolute or relative paths or urls as string array
@@ -188,10 +188,10 @@ public class ImageLocator {
}
/**
- * the given paths <br />- might be a file path or an url (http/https) <br
- * />- if file path relative: make absolute path based on current working
- * directory <br />- are removed from the list <br />- and then added to the
- * beginning of the list (file path: if it exists) <br />as entry 1 after
+ * the given paths <br>- might be a file path or an url (http/https) <br>
+ * - if file path relative: make absolute path based on current working
+ * directory <br>- are removed from the list <br>- and then added to the
+ * beginning of the list (file path: if it exists) <br>as entry 1 after
* the current bundlepath (entry 0)
*
* @param pl absolute or relative paths or urls as string array
@@ -201,9 +201,9 @@ public class ImageLocator {
}
/**
- * the given path(s) <br />- might be a file path or an url (http/https) <br
- * />- if file path relative: make absolute path based on current working
- * directory <br />- is/are removed from the list
+ * the given path(s) <br>- might be a file path or an url (http/https) <br>
+ * - if file path relative: make absolute path based on current working
+ * directory <br>- is/are removed from the list
*
* @param path absolute or relative path(s) or url(s) might be a path list
* string with seperator : (or ; Windows)
@@ -216,9 +216,9 @@ public class ImageLocator {
}
/**
- * the given path(s) <br />- might be a file path or an url (http/https) <br
- * />- if file path relative: make absolute path based on current working
- * directory <br />- is/are removed from the list
+ * the given path(s) <br>- might be a file path or an url (http/https) <br>
+ * - if file path relative: make absolute path based on current working
+ * directory <br>- is/are removed from the list
*
* @param pl absolute or relative path(s) or url(s) as string array
*/
@@ -249,9 +249,9 @@ public class ImageLocator {
}
/**
- * the current list is emptied <br />then add -DSIKULI_IMAGE_PATH=... and
+ * the current list is emptied <br>then add -DSIKULI_IMAGE_PATH=... and
* Env(SIKULI_IMAGE_PATH)
- * <br /> then the given path(s) are added using addImagePath()
+ * <br> then the given path(s) are added using addImagePath()
*
* @param path absolute or relative path(s) or url(s) might be a path list
* string with seperator : (or ; Windows)
@@ -268,9 +268,9 @@ public class ImageLocator {
}
/**
- * the current list is emptied <br />then add -DSIKULI_IMAGE_PATH=... and
+ * the current list is emptied <br>then add -DSIKULI_IMAGE_PATH=... and
* Env(SIKULI_IMAGE_PATH)
- * <br /> then the given path(s) are added using addImagePath()
+ * <br> then the given path(s) are added using addImagePath()
*
* @param pl absolute or relative path(s) or url(s) as string array
*/
@@ -349,14 +349,14 @@ public class ImageLocator {
}
/**
- * findX the file in the following order: <br />1. absolute path or url x)
- * <br />2. bundle path <br />3. ENV[SIKULI_IMAGE_PATH] <br />4. Java
- * -DSIKULI_IMAGE_PATH <br />5. paths added later using addImagePath or via
+ * findX the file in the following order: <br>1. absolute path or url x)
+ * <br>2. bundle path <br>3. ENV[SIKULI_IMAGE_PATH] <br>4. Java
+ * -DSIKULI_IMAGE_PATH <br>5. paths added later using addImagePath or via
* import ... .sikuli
*
* @param filename relative, absolute or url
* @return absolute path string
- * @throws IOException if filename cannot be located <br />x) files behind
+ * @throws IOException if filename cannot be located <br>x) files behind
* urls are loaded to local cash
*/
private static String locate(String filename) throws IOException {
diff --git a/API/src/main/java/org/sikuli/script/ImagePath.java b/API/src/main/java/org/sikuli/script/ImagePath.java
index 66aee2f..be458ae 100644
--- a/API/src/main/java/org/sikuli/script/ImagePath.java
+++ b/API/src/main/java/org/sikuli/script/ImagePath.java
@@ -142,7 +142,7 @@ public class ImagePath {
* Set the primary image path to the top folder level of a jar based on the given class name (must
* be found on class path). When not running from a jar (e.g. running in some IDE) the path will be the
* path to the compiled classes (for Maven based projects this is target/classes that contains all
- * stuff copied from src/main/resources automatically)<br />
+ * stuff copied from src/main/resources automatically)<br>
*
* @param mainPath a valid classname optionally followed by /subfolder...
* @param altPath alternative image folder, when not running from jar (absolute path)
diff --git a/API/src/main/java/org/sikuli/script/Location.java b/API/src/main/java/org/sikuli/script/Location.java
index 67ee34e..89d3b92 100755
--- a/API/src/main/java/org/sikuli/script/Location.java
+++ b/API/src/main/java/org/sikuli/script/Location.java
@@ -105,10 +105,10 @@ public class Location {
}
/**
- * Returns null, if outside of any screen<br />
+ * Returns null, if outside of any screen<br>
* subsequent actions might crash
*
- * @return the screen, that contains the given point.<br />
+ * @return the screen, that contains the given point.<br>
*/
public Screen getScreen() {
Rectangle r;
@@ -186,8 +186,8 @@ public class Location {
}
/**
- * create a region with a corner at this point<br />as specified with x y<br /> 0 0 top left<br />
- * 0 1 bottom left<br /> 1 0 top right<br /> 1 1 bottom right<br />
+ * create a region with a corner at this point<br>as specified with x y<br> 0 0 top left<br>
+ * 0 1 bottom left<br> 1 0 top right<br> 1 1 bottom right<br>
*
* @param CREATE_X_DIRECTION == 0 is left side !=0 is right side, see {@link Region#CREATE_X_DIRECTION_LEFT}, {@link Region#CREATE_X_DIRECTION_RIGHT}
* @param CREATE_Y_DIRECTION == 0 is top side !=0 is bottom side, see {@link Region#CREATE_Y_DIRECTION_TOP}, {@link Region#CREATE_Y_DIRECTION_BOTTOM}
@@ -200,7 +200,7 @@ public class Location {
}
/**
- * moves the point the given amounts in the x and y direction, might be negative <br />might move
+ * moves the point the given amounts in the x and y direction, might be negative <br>might move
* point outside of any screen, not checked
*
* @param dx
@@ -224,7 +224,7 @@ public class Location {
}
/**
- * changes the locations x and y value to the given values (moves it) <br />might move point
+ * changes the locations x and y value to the given values (moves it) <br>might move point
* outside of any screen, not checked
*
* @param X
@@ -248,7 +248,7 @@ public class Location {
}
/**
- * creates a point at the given offset, might be negative <br />might create a point outside of
+ * creates a point at the given offset, might be negative <br>might create a point outside of
* any screen, not checked
*
* @param dx
@@ -260,7 +260,7 @@ public class Location {
}
/**
- * creates a point at the given offset, might be negative <br />might create a point outside of
+ * creates a point at the given offset, might be negative <br>might create a point outside of
* any screen, not checked
*
* @param loc
@@ -271,7 +271,7 @@ public class Location {
}
/**
- * creates a point at the given offset to the left, might be negative <br />might create a point
+ * creates a point at the given offset to the left, might be negative <br>might create a point
* outside of any screen, not checked
*
* @param dx
@@ -282,7 +282,7 @@ public class Location {
}
/**
- * creates a point at the given offset to the right, might be negative <br />might create a point
+ * creates a point at the given offset to the right, might be negative <br>might create a point
* outside of any screen, not checked
*
* @param dx
@@ -293,7 +293,7 @@ public class Location {
}
/**
- * creates a point at the given offset above, might be negative <br />might create a point outside
+ * creates a point at the given offset above, might be negative <br>might create a point outside
* of any screen, not checked
*
* @param dy
@@ -304,7 +304,7 @@ public class Location {
}
/**
- * creates a point at the given offset below, might be negative <br />might create a point outside
+ * creates a point at the given offset below, might be negative <br>might create a point outside
* of any screen, not checked
*
* @param dy
diff --git a/API/src/main/java/org/sikuli/script/Match.java b/API/src/main/java/org/sikuli/script/Match.java
index f31cc4e..4cd6728 100755
--- a/API/src/main/java/org/sikuli/script/Match.java
+++ b/API/src/main/java/org/sikuli/script/Match.java
@@ -12,9 +12,9 @@ import org.sikuli.natives.FindResult;
/**
* holds the result of a findX operation, is itself the region on the screen,
- * where the image was found and hence inherits all methods from Region<br />
- * attributes:<br /> the match score (0 ... 1.0)<br /> the click target (e.g.
- * from Pattern)<br /> the filename of the used image<br />or the text used for
+ * where the image was found and hence inherits all methods from Region<br>
+ * attributes:<br> the match score (0 ... 1.0)<br> the click target (e.g.
+ * from Pattern)<br> the filename of the used image<br>or the text used for
* findX text
*/
public class Match extends Region implements Comparable {
@@ -32,7 +32,7 @@ public class Match extends Region implements Comparable {
}
/**
- * create a copy of Match object<br />
+ * create a copy of Match object<br>
* to e.g. set another TargetOffset for same match
*
* @param m
diff --git a/API/src/main/java/org/sikuli/script/Mouse.java b/API/src/main/java/org/sikuli/script/Mouse.java
index dc89471..8e962cd 100644
--- a/API/src/main/java/org/sikuli/script/Mouse.java
+++ b/API/src/main/java/org/sikuli/script/Mouse.java
@@ -8,15 +8,15 @@ import org.sikuli.basics.Debug;
import org.sikuli.basics.Settings;
/**
- * Main pupose is to coordinate the mouse usage among threads <br />
- * At any one time, the mouse has one owner (usually a Region object) <br />
- * who exclusively uses the mouse, all others wait for the mouse to be free again <br />
- * if more than one possible owner is waiting, the next owner is uncertain <br />
+ * Main pupose is to coordinate the mouse usage among threads <br>
+ * At any one time, the mouse has one owner (usually a Region object) <br>
+ * who exclusively uses the mouse, all others wait for the mouse to be free again <br>
+ * if more than one possible owner is waiting, the next owner is uncertain <br>
* It is detected, when the mouse is moved external from the workflow, which can be
- * used for appropriate actions (e.g. pause a script) <br />
+ * used for appropriate actions (e.g. pause a script) <br>
* the mouse can be blocked for a longer time, so only this owner can use
- * the mouse (like some transactional processing) <br />
- * Currently deadlocks and infinite waits are not detected, but should not happen ;-) <br />
+ * the mouse (like some transactional processing) <br>
+ * Currently deadlocks and infinite waits are not detected, but should not happen ;-) <br>
* Contained are methods to use the mouse (click, move, button down/up) as is
*/
public class Mouse {
@@ -71,12 +71,12 @@ public class Mouse {
}
/**
- * what to do if mouse is moved outside Sikuli's mouse protection <br />
- * - Mouse.MouseMovedIgnore (0) ignore it (default) <br />
- * - Mouse.MouseMovedShow (1) show and ignore it <br />
- * - Mouse.MouseMovedPause (2) show it and pause until user says continue <br />
- * - Mouse.MouseMovedAction (3) perform a user defined action <br />
- * 2 and 3 not implemented yet, 1 is used <br />
+ * what to do if mouse is moved outside Sikuli's mouse protection <br>
+ * - Mouse.MouseMovedIgnore (0) ignore it (default) <br>
+ * - Mouse.MouseMovedShow (1) show and ignore it <br>
+ * - Mouse.MouseMovedPause (2) show it and pause until user says continue <br>
+ * - Mouse.MouseMovedAction (3) perform a user defined action <br>
+ * 2 and 3 not implemented yet, 1 is used <br>
*
* @param mouseMovedResponse
*/
@@ -86,7 +86,7 @@ public class Mouse {
}
/**
- * to block the mouse globally <br />
+ * to block the mouse globally <br>
* only the contained mouse methods without owner will be granted
*
* @return success
@@ -96,7 +96,7 @@ public class Mouse {
}
/**
- * to block the mouse globally for the given owner <br />
+ * to block the mouse globally for the given owner <br>
* only the contained mouse methods having the same owner will be granted
*
* @return success
@@ -255,16 +255,16 @@ public class Mouse {
* to click (left, right, middle - single or double) at the given location using the given button
* only useable for local screens
*
- * timing parameters: <br />
- * - one value <br />
- * < 0 wait before mouse down <br />
- * > 0 wait after mouse up <br />
+ * timing parameters: <br>
+ * - one value <br>
+ * < 0 wait before mouse down <br>
+ * > 0 wait after mouse up <br>
* - 2 or 3 values
- * 1st wait before mouse down <br />
- * 2nd wait after mouse up <br />
+ * 1st wait before mouse down <br>
+ * 2nd wait after mouse up <br>
* 3rd inner wait (milli secs, cut to 1000): pause between mouse down and up (Settings.ClickDelay)
*
- * wait before and after: > 59 taken as milli secs - ;lt& are seconds
+ * wait before and after: > 59 taken as milli secs - < are seconds
*
* @param loc where to click
* @param action L,R,M left, right, middle - D means double click
@@ -445,7 +445,7 @@ public class Mouse {
}
/**
- * move mouse using mouse wheel in the given direction the given steps <br />
+ * move mouse using mouse wheel in the given direction the given steps <br>
* the result is system dependent
*
* @param direction
diff --git a/API/src/main/java/org/sikuli/script/Observer.java b/API/src/main/java/org/sikuli/script/Observer.java
index 00e033f..604fd3b 100644
--- a/API/src/main/java/org/sikuli/script/Observer.java
+++ b/API/src/main/java/org/sikuli/script/Observer.java
@@ -112,7 +112,7 @@ public class Observer {
}
/**
- * remove the observer from the list, a region observer will be stopped <br />
+ * remove the observer from the list, a region observer will be stopped <br>
* registered events for that observer are removed as well
*
* @param name name of observer
@@ -123,10 +123,9 @@ public class Observer {
}
/**
- * stop and remove all observers registered for this region from the list <br />
+ * stop and remove all observers registered for this region from the list <br>
* registered events for those observers are removed as well
- *
- * @param name name of observer
+ *
* @return success
*/
public static boolean remove(Region reg) {
@@ -134,7 +133,7 @@ public class Observer {
}
/**
- * stop and remove the observer registered for this region from the list <br />
+ * stop and remove the observer registered for this region from the list <br>
* registered events for that observer are removed as well
*
* @param reg the observed region
@@ -244,7 +243,7 @@ public class Observer {
* add a new event to the list
*
* @param name name of event
- * @param ev the event object (SikuliEvent is copied)
+ * @param pev the event object (SikuliEvent is copied)
* @return
*/
public static synchronized long addEvent(String name, Object pev) {
@@ -268,7 +267,7 @@ public class Observer {
}
/**
- * remove and return the latest event for the named observer <br />
+ * remove and return the latest event for the named observer <br>
* earlier events are removed
*
* @param name
@@ -302,10 +301,9 @@ public class Observer {
}
/**
- * remove and return the latest events for that region <br />
+ * remove and return the latest events for that region <br>
* earlier events are removed
- *
- * @param name
+ *
* @return the array of events or size 0 array if none
*/
public static synchronized Event[] getEvents(Region reg) {
@@ -317,7 +315,7 @@ public class Observer {
}
/**
- * return the latest events (these are preserved) <br />
+ * return the latest events (these are preserved) <br>
* earlier events for the same observer are removed
*
* @return the array of events or size 0 array if none
diff --git a/API/src/main/java/org/sikuli/script/ObserverCallBack.java b/API/src/main/java/org/sikuli/script/ObserverCallBack.java
index 2d6865c..433a25e 100644
--- a/API/src/main/java/org/sikuli/script/ObserverCallBack.java
+++ b/API/src/main/java/org/sikuli/script/ObserverCallBack.java
@@ -8,15 +8,15 @@ package org.sikuli.script;
/**
*
- * 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 <br>
+ * onAppear, onVanish and onChange <br>
* by overriding the contained empty methods appeared, vanished and changed
*
- * example:<br />
- * aRegion.onAppear(anImage, <br />
- * new ObserverCallBack() { <br />
- * @Override <br />
- * appeared(SikuliEvent e) { <br />
+ * example:<br>
+ * aRegion.onAppear(anImage, <br>
+ * new ObserverCallBack() { <br>
+ * <br>
+ * appeared(SikuliEvent e) { <br>
* // do something
* }
* }
diff --git a/API/src/main/java/org/sikuli/script/Pattern.java b/API/src/main/java/org/sikuli/script/Pattern.java
index 8497a76..8df42d1 100755
--- a/API/src/main/java/org/sikuli/script/Pattern.java
+++ b/API/src/main/java/org/sikuli/script/Pattern.java
@@ -11,9 +11,9 @@ import java.awt.image.BufferedImage;
import java.net.URL;
/**
- * to define a more complex search target<br />
- * - non-standard minimum similarity <br />
- * - click target other than center <br />
+ * to define a more complex search target<br>
+ * - non-standard minimum similarity <br>
+ * - click target other than center <br>
* - image as in-memory image
*/
public class Pattern {
@@ -43,7 +43,7 @@ public class Pattern {
}
/**
- * create a Pattern with given image<br />
+ * create a Pattern with given image<br>
*
* @param img
*/
@@ -52,7 +52,7 @@ public class Pattern {
}
/**
- * create a Pattern based on an image file name<br />
+ * create a Pattern based on an image file name<br>
*
* @param imgpath
*/
@@ -130,8 +130,8 @@ public class Pattern {
/**
* the current image's absolute filepath
- * <br />will return null, if image is in jar or in web
- * <br />use getFileURL in this case
+ * <br>will return null, if image is in jar or in web
+ * <br>use getFileURL in this case
*
* @return might be null
*/
diff --git a/API/src/main/java/org/sikuli/script/Region.java b/API/src/main/java/org/sikuli/script/Region.java
index 6846aae..dee483c 100755
--- a/API/src/main/java/org/sikuli/script/Region.java
+++ b/API/src/main/java/org/sikuli/script/Region.java
@@ -343,7 +343,7 @@ public class Region {
}
/**
- * Create a new region from another region<br />including the region's settings
+ * Create a new region from another region<br>including the region's settings
*
* @param r the region
*/
@@ -424,8 +424,8 @@ public class Region {
public final static int CREATE_Y_DIRECTION_BOTTOM = 1;
/**
- * create a region with a corner at the given point<br />as specified with x y<br /> 0 0 top
- * left<br /> 0 1 bottom left<br /> 1 0 top right<br /> 1 1 bottom right<br />
+ * create a region with a corner at the given point<br>as specified with x y<br> 0 0 top
+ * left<br> 0 1 bottom left<br> 1 0 top right<br> 1 1 bottom right<br>
*
* @param loc the refence point
* @param create_x_direction == 0 is left side !=0 is right side
@@ -460,8 +460,8 @@ public class Region {
}
/**
- * create a region with a corner at the given point<br />as specified with x y<br /> 0 0 top
- * left<br /> 0 1 bottom left<br /> 1 0 top right<br /> 1 1 bottom right<br />same as the
+ * create a region with a corner at the given point<br>as specified with x y<br> 0 0 top
+ * left<br> 0 1 bottom left<br> 1 0 top right<br> 1 1 bottom right<br>same as the
* corresponding create method, here to be naming compatible with class Location
*
* @param loc the refence point
@@ -497,7 +497,7 @@ public class Region {
}
/**
- * Create a region from another region<br />including the region's settings
+ * Create a region from another region<br>including the region's settings
*
* @param r the region
* @return then new region
@@ -594,7 +594,7 @@ public class Region {
//<editor-fold defaultstate="collapsed" desc="handle Settings">
/**
* true - (initial setting) should throw exception FindFailed if findX unsuccessful in this
- * region<br /> false - do not abort script on FindFailed (might leed to null pointer exceptions
+ * region<br> false - do not abort script on FindFailed (might leed to null pointer exceptions
* later)
*
* @param flag true/false
@@ -619,7 +619,7 @@ public class Region {
/**
* the time in seconds a find operation should wait for the appearence of the target in this
- * region<br /> initial value 3 secs
+ * region<br> initial value 3 secs
*
* @param sec
*/
@@ -637,9 +637,9 @@ public class Region {
}
/**
- * FindFailedResponse.<br /> ABORT - (initial value) abort script on FindFailed (=
- * setThrowException(true) )<br /> SKIP - ignore FindFailed (same as setThrowException(false) )<br
- * /> PROMPT - display prompt on FindFailed to let user decide how to proceed<br /> RETRY -
+ * FindFailedResponse.<br> ABORT - (initial value) abort script on FindFailed (=
+ * setThrowException(true) )<br> SKIP - ignore FindFailed (same as setThrowException(false) )<br>
+ * PROMPT - display prompt on FindFailed to let user decide how to proceed<br> RETRY -
* continue to wait for appearence on FindFailed (caution: endless loop)
*
* @param response the FindFailedResponse
@@ -978,7 +978,7 @@ public class Region {
}
/**
- * set the regions position/size<br />this might move the region even to another screen
+ * set the regions position/size<br>this might move the region even to another screen
*
* @param r the AWT Rectangle to use for position/size
* @return the region itself
@@ -988,7 +988,7 @@ public class Region {
}
/**
- * set the regions position/size<br />this might move the region even to another screen
+ * set the regions position/size<br>this might move the region even to another screen
*
* @param X new x of top left corner
* @param Y new y of top left corner
@@ -1006,7 +1006,7 @@ public class Region {
}
/**
- * set the regions position/size<br />this might move the region even to another screen
+ * set the regions position/size<br>this might move the region even to another screen
*
* @param r the region to use for position/size
* @return the region itself
@@ -1017,7 +1017,7 @@ public class Region {
// ****************************************************
/**
- * resets this region to the given location, and size <br /> this might move the region even to
+ * resets this region to the given location, and size <br> this might move the region even to
* another screen
*
* Because of the wanted side effect for the containing screen, this should only be used with
@@ -1037,7 +1037,7 @@ public class Region {
}
/**
- * resets this region to the given rectangle <br /> this might move the region even to another
+ * resets this region to the given rectangle <br> this might move the region even to another
* screen
*
* Because of the wanted side effect for the containing screen, this should only be used with
@@ -1050,7 +1050,7 @@ public class Region {
}
/**
- * resets this region to the given region <br /> this might move the region even to another screen
+ * resets this region to the given region <br> this might move the region even to another screen
*
* Because of the wanted side effect for the containing screen, this should only be used with
* screen objects. For Region objects use setRect() instead.
@@ -1073,7 +1073,7 @@ public class Region {
}
/**
- * set the regions position<br />this might move the region even to another screen
+ * set the regions position<br>this might move the region even to another screen
*
* @param loc new top left corner
* @return the region itself
@@ -1085,7 +1085,7 @@ public class Region {
}
/**
- * set the regions position<br />this might move the region even to another screen
+ * set the regions position<br>this might move the region even to another screen
*
* @param loc new top left corner
* @return the region itself
@@ -1098,7 +1098,7 @@ public class Region {
}
/**
- * set the regions position/size<br />this might move the region even to another screen
+ * set the regions position/size<br>this might move the region even to another screen
*
* @param r
* @return the region itself
@@ -1110,7 +1110,7 @@ public class Region {
}
/**
- * resize the region using the given padding values<br />might be negative
+ * resize the region using the given padding values<br>might be negative
*
* @param l padding on left side
* @param r padding on right side
@@ -1134,7 +1134,7 @@ public class Region {
}
/**
- * extend the region, so it contains the given region<br />but only the part inside the current
+ * extend the region, so it contains the given region<br>but only the part inside the current
* screen
*
* @param r the region to include
@@ -1149,7 +1149,7 @@ public class Region {
}
/**
- * extend the region, so it contains the given point<br />but only the part inside the current
+ * extend the region, so it contains the given point<br>but only the part inside the current
* screen
*
* @param loc the point to include
@@ -1165,7 +1165,7 @@ public class Region {
// ************************************************
/**
- * a find operation saves its match on success in the used region object<br />unchanged if not
+ * a find operation saves its match on success in the used region object<br>unchanged if not
* successful
*
* @return the Match object from last successful find in this region
@@ -1176,7 +1176,7 @@ public class Region {
// ************************************************
/**
- * a searchAll operation saves its matches on success in the used region object<br />unchanged if
+ * a searchAll operation saves its matches on success in the used region object<br>unchanged if
* not successful
*
* @return a Match-Iterator of matches from last successful searchAll in this region
@@ -1291,7 +1291,7 @@ public class Region {
}
/**
- * create a region enlarged w pixels on left and right side<br /> and h pixels at top and bottom
+ * create a region enlarged w pixels on left and right side<br> and h pixels at top and bottom
*
* @param w
* @param h
@@ -1304,8 +1304,8 @@ public class Region {
}
/**
- * create a region enlarged l pixels on left and r pixels right side<br /> and t pixels at top
- * side and b pixels at bottom side <br />
+ * create a region enlarged l pixels on left and r pixels right side<br> and t pixels at top
+ * side and b pixels at bottom side <br>
* negative values go inside (shrink)
*
* @param l add to the left
@@ -1327,7 +1327,7 @@ public class Region {
}
/**
- * positive offset goes to the right <br />might be off current screen
+ * positive offset goes to the right <br>might be off current screen
*
* @return point with given offset horizontally to middle point on right edge
*/
@@ -1336,8 +1336,8 @@ public class Region {
}
/**
- * create a region right of the right side with same height<br /> the new region extends to the
- * right screen border<br /> use grow() to include the current region
+ * create a region right of the right side with same height<br> the new region extends to the
+ * right screen border<br> use grow() to include the current region
*
* @return the new region
*/
@@ -1347,7 +1347,7 @@ public class Region {
}
/**
- * create a region right of the right side with same height and given width<br />
+ * create a region right of the right side with same height and given width<br>
* negative width creates the right part with width inside the region
* use grow() to include the current region
*
@@ -1373,7 +1373,7 @@ public class Region {
}
/**
- * negative offset goes to the left <br />might be off current screen
+ * negative offset goes to the left <br>might be off current screen
*
* @return point with given offset horizontally to middle point on left edge
*/
@@ -1382,8 +1382,8 @@ public class Region {
}
/**
- * create a region left of the left side with same height<br /> the new region extends to the left
- * screen border<br /> use grow() to include the current region
+ * create a region left of the left side with same height<br> the new region extends to the left
+ * screen border<br> use grow() to include the current region
*
* @return the new region
*/
@@ -1393,9 +1393,9 @@ public class Region {
}
/**
- * create a region left of the left side with same height and given width<br />
+ * create a region left of the left side with same height and given width<br>
* negative width creates the left part with width inside the region
- * use grow() to include the current region <br />
+ * use grow() to include the current region <br>
*
* @param width
* @return the new region
@@ -1419,7 +1419,7 @@ public class Region {
}
/**
- * negative offset goes towards top of screen <br />might be off current screen
+ * negative offset goes towards top of screen <br>might be off current screen
*
* @return point with given offset vertically to middle point on top edge
*/
@@ -1428,8 +1428,8 @@ public class Region {
}
/**
- * create a region above the top side with same width<br /> the new region extends to the top
- * screen border<br /> use grow() to include the current region
+ * create a region above the top side with same width<br> the new region extends to the top
+ * screen border<br> use grow() to include the current region
*
* @return the new region
*/
@@ -1439,7 +1439,7 @@ public class Region {
}
/**
- * create a region above the top side with same width and given height<br />
+ * create a region above the top side with same width and given height<br>
* negative height creates the top part with height inside the region
* use grow() to include the current region
*
@@ -1465,7 +1465,7 @@ public class Region {
}
/**
- * positive offset goes towards bottom of screen <br />might be off current screen
+ * positive offset goes towards bottom of screen <br>might be off current screen
*
* @return point with given offset vertically to middle point on bottom edge
*/
@@ -1474,8 +1474,8 @@ public class Region {
}
/**
- * create a region below the bottom side with same width<br /> the new region extends to the
- * bottom screen border<br /> use grow() to include the current region
+ * create a region below the bottom side with same width<br> the new region extends to the
+ * bottom screen border<br> use grow() to include the current region
*
* @return the new region
*/
@@ -1485,7 +1485,7 @@ public class Region {
}
/**
- * create a region below the bottom side with same width and given height<br />
+ * create a region below the bottom side with same width and given height<br>
* negative height creates the bottom part with height inside the region
* use grow() to include the current region
*
@@ -1525,17 +1525,17 @@ public class Region {
}
/**
- * select the specified part of the region <br />
- * example for upper part of region (NORTH) <br />
- * NORTH (N2) - upper half <br />
- * NORTH_NORTH (N3) - middle third in upper third <br />
- * NORTH_EAST (NE) - right third in upper third <br />
- * NORTH_WEST (NW) - left third in upper third <br />
- * ... similar for the other directions <br />
- * MID_VERTICAL (MV) half of width vertically centered <br />
- * MID_HORIZONTAL (MV) half of height horizontally centered <br />
- * MID_HALF (M2) half of width / half of height centered <br />
- * MID_THIRD (M3) third of width / third of height centered <br />
+ * select the specified part of the region <br>
+ * example for upper part of region (NORTH) <br>
+ * NORTH (N2) - upper half <br>
+ * NORTH_NORTH (N3) - middle third in upper third <br>
+ * NORTH_EAST (NE) - right third in upper third <br>
+ * NORTH_WEST (NW) - left third in upper third <br>
+ * ... similar for the other directions <br>
+ * MID_VERTICAL (MV) half of width vertically centered <br>
+ * MID_HORIZONTAL (MV) half of height horizontally centered <br>
+ * MID_HALF (M2) half of width / half of height centered <br>
+ * MID_THIRD (M3) third of width / third of height centered <br>
* @param reg
* @return new region
*/
@@ -1597,7 +1597,7 @@ public class Region {
}
/**
- * store info: this region is divided vertically into n even rows <br />
+ * store info: this region is divided vertically into n even rows <br>
* a preparation for using getRow()
* @param n
* @return the top row
@@ -1607,7 +1607,7 @@ public class Region {
}
/**
- * store info: this region is divided horizontally into n even columns <br />
+ * store info: this region is divided horizontally into n even columns <br>
* a preparation for using getCol()
* @param n
* @return the leftmost column
@@ -1633,7 +1633,7 @@ public class Region {
}
/**
- * store info: this region is divided into a raster of even cells <br />
+ * store info: this region is divided into a raster of even cells <br>
* a preparation for using getCell()
* @param r
* @param c
@@ -1694,7 +1694,7 @@ public class Region {
}
/**
- * get the specified cell counting from (0, 0), if a raster is setup <br />
+ * get the specified cell counting from (0, 0), if a raster is setup <br>
* negative counts reverse from the end (last = -1)
* values outside range are 0 or last respectively
* @param c
@@ -1785,7 +1785,7 @@ public class Region {
}
/**
- * hack to implement the getLastMatch() convenience 0 means same as highlight() <.0 same as
+ * hack to implement the getLastMatch() convenience 0 means same as highlight() < 0 same as
* highlight(secs) if available the last match is highlighted
*
* @param secs
@@ -1842,8 +1842,8 @@ public class Region {
}
/**
- * return false to skip <br />
- * return true to try again <br />
+ * return false to skip <br>
+ * return true to try again <br>
* throw FindFailed to abort
*
* @param target Handles a failed find action
@@ -1942,7 +1942,7 @@ public class Region {
}
/**
- * Iterator<Match> searchAll( Pattern/String/Image ) finds the given pattern on the screen and
+ * Iterator<Match> searchAll( Pattern/String/Image ) finds the given pattern on the screen and
* returns the best match. If AutoWaitTimeout is set, this is equivalent to wait().
*
* @param target A search criteria
@@ -2038,7 +2038,7 @@ public class Region {
}
/**
- * Check if target exists with a specified timeout<br />
+ * Check if target exists with a specified timeout<br>
* timout = 0: returns immediately after first search
*
* @param target Pattern, String or Image
@@ -2589,8 +2589,8 @@ public class Region {
}
/**
- * move the mouse pointer to region's last successful match <br />use center if no lastMatch <br
- * />if region is a match: move to targetOffset <br />same as mouseMove
+ * move the mouse pointer to region's last successful match <br>use center if no lastMatch <br>
+ * if region is a match: move to targetOffset <br>same as mouseMove
*
* @return 1 if possible, 0 otherwise
*/
@@ -2603,9 +2603,9 @@ public class Region {
}
/**
- * move the mouse pointer to the given target location<br /> same as mouseMove<br /> Pattern or
- * Filename - do a find before and use the match<br /> Region - position at center<br /> Match -
- * position at match's targetOffset<br /> Location - position at that point<br />
+ * move the mouse pointer to the given target location<br> same as mouseMove<br> Pattern or
+ * Filename - do a find before and use the match<br> Region - position at center<br> Match -
+ * position at match's targetOffset<br> Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @return 1 if possible, 0 otherwise
@@ -2618,7 +2618,7 @@ public class Region {
}
/**
- * left click at the region's last successful match <br />use center if no lastMatch <br />if
+ * left click at the region's last successful match <br>use center if no lastMatch <br>if
* region is a match: click targetOffset
*
* @return 1 if possible, 0 otherwise
@@ -2632,9 +2632,9 @@ public class Region {
}
/**
- * left click at the given target location<br /> Pattern or Filename - do a find before and use
- * the match<br /> Region - position at center<br /> Match - position at match's targetOffset<br
- * /> Location - position at that point<br />
+ * left click at the given target location<br> Pattern or Filename - do a find before and use
+ * the match<br> Region - position at center<br> Match - position at match's targetOffset<br>
+ * Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @return 1 if possible, 0 otherwise
@@ -2646,9 +2646,9 @@ public class Region {
}
/**
- * left click at the given target location<br /> holding down the given modifier keys<br />
- * Pattern or Filename - do a find before and use the match<br /> Region - position at center<br
- * /> Match - position at match's targetOffset<br /> Location - position at that point<br />
+ * left click at the given target location<br> holding down the given modifier keys<br>
+ * Pattern or Filename - do a find before and use the match<br> Region - position at center<br>
+ * Match - position at match's targetOffset<br> Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @param modifiers the value of the resulting bitmask (see KeyModifier)
@@ -2665,7 +2665,7 @@ public class Region {
}
/**
- * double click at the region's last successful match <br />use center if no lastMatch <br />if
+ * double click at the region's last successful match <br>use center if no lastMatch <br>if
* region is a match: click targetOffset
*
* @return 1 if possible, 0 otherwise
@@ -2679,9 +2679,9 @@ public class Region {
}
/**
- * double click at the given target location<br /> Pattern or Filename - do a find before and use
- * the match<br /> Region - position at center<br /> Match - position at match's targetOffset<br
- * /> Location - position at that point<br />
+ * double click at the given target location<br> Pattern or Filename - do a find before and use
+ * the match<br> Region - position at center<br> Match - position at match's targetOffset<br>
+ * Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @return 1 if possible, 0 otherwise
@@ -2693,9 +2693,9 @@ public class Region {
}
/**
- * double click at the given target location<br /> holding down the given modifier keys<br />
- * Pattern or Filename - do a find before and use the match<br /> Region - position at center<br
- * /> Match - position at match's targetOffset<br /> Location - position at that point<br />
+ * double click at the given target location<br> holding down the given modifier keys<br>
+ * Pattern or Filename - do a find before and use the match<br> Region - position at center<br
+ *> Match - position at match's targetOffset<br> Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @param modifiers the value of the resulting bitmask (see KeyModifier)
@@ -2712,7 +2712,7 @@ public class Region {
}
/**
- * right click at the region's last successful match <br />use center if no lastMatch <br />if
+ * right click at the region's last successful match <br>use center if no lastMatch <br>if
* region is a match: click targetOffset
*
* @return 1 if possible, 0 otherwise
@@ -2726,9 +2726,9 @@ public class Region {
}
/**
- * right click at the given target location<br /> Pattern or Filename - do a find before and use
- * the match<br /> Region - position at center<br /> Match - position at match's targetOffset<br
- * /> Location - position at that point<br />
+ * right click at the given target location<br> Pattern or Filename - do a find before and use
+ * the match<br> Region - position at center<br> Match - position at match's targetOffset<br
+ *> Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @return 1 if possible, 0 otherwise
@@ -2740,9 +2740,9 @@ public class Region {
}
/**
- * right click at the given target location<br /> holding down the given modifier keys<br />
- * Pattern or Filename - do a find before and use the match<br /> Region - position at center<br
- * /> Match - position at match's targetOffset<br /> Location - position at that point<br />
+ * right click at the given target location<br> holding down the given modifier keys<br>
+ * Pattern or Filename - do a find before and use the match<br> Region - position at center<br
+ *> Match - position at match's targetOffset<br> Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @param modifiers the value of the resulting bitmask (see KeyModifier)
@@ -2770,8 +2770,8 @@ public class Region {
//<editor-fold defaultstate="collapsed" desc="Mouse actions - drag & drop">
/**
- * Drag from region's last match and drop at given target <br />applying Settings.DelayAfterDrag
- * and DelayBeforeDrop <br /> using left mouse button
+ * Drag from region's last match and drop at given target <br>applying Settings.DelayAfterDrag
+ * and DelayBeforeDrop <br> using left mouse button
*
* @param <PatternFilenameRegionMatchLocation> target destination position
* @return 1 if possible, 0 otherwise
@@ -2783,7 +2783,7 @@ public class Region {
}
/**
- * Drag from a position and drop to another using left mouse button<br />applying
+ * Drag from a position and drop to another using left mouse button<br>applying
* Settings.DelayAfterDrag and DelayBeforeDrop
*
* @param t1 source position
@@ -2819,8 +2819,8 @@ public class Region {
}
/**
- * Prepare a drag action: move mouse to given target <br />press and hold left mouse button <br
- * />wait Settings.DelayAfterDrag
+ * Prepare a drag action: move mouse to given target <br>press and hold left mouse button <br
+ *>wait Settings.DelayAfterDrag
*
* @param <PatternFilenameRegionMatchLocation> target
* @return 1 if possible, 0 otherwise
@@ -2845,8 +2845,8 @@ public class Region {
}
/**
- * finalize a drag action with a drop: move mouse to given target <br />wait
- * Settings.DelayBeforeDrop <br />release the left mouse button
+ * finalize a drag action with a drop: move mouse to given target <br>wait
+ * Settings.DelayBeforeDrop <br>release the left mouse button
*
* @param <PatternFilenameRegionMatchLocation> target
* @return 1 if possible, 0 otherwise
@@ -2900,7 +2900,7 @@ public class Region {
}
/**
- * move the mouse pointer to the region's last successful match<br />same as hover<br />
+ * move the mouse pointer to the region's last successful match<br>same as hover<br>
*
* @return 1 if possible, 0 otherwise
*/
@@ -2916,10 +2916,10 @@ public class Region {
}
/**
- * move the mouse pointer to the given target location<br /> same as hover<br /> Pattern or
- * Filename - do a find before and use the match<br /> Region - position at center<br /> Match -
- * position at match's targetOffset<br />
- * Location - position at that point<br />
+ * move the mouse pointer to the given target location<br> same as hover<br> Pattern or
+ * Filename - do a find before and use the match<br> Region - position at center<br> Match -
+ * position at match's targetOffset<br>
+ * Location - position at that point<br>
*
* @param <PatternFilenameRegionMatchLocation> target
* @param target
@@ -2933,8 +2933,8 @@ public class Region {
}
/**
- * Move the wheel at the current mouse position<br /> the given steps in the given direction: <br
- * />Button.WHEEL_DOWN, Button.WHEEL_UP
+ * Move the wheel at the current mouse position<br> the given steps in the given direction: <br
+ *>Button.WHEEL_DOWN, Button.WHEEL_UP
*
* @param direction to move the wheel
* @param steps the number of steps
@@ -2946,8 +2946,8 @@ public class Region {
}
/**
- * move the mouse pointer to the given target location<br /> and move the wheel the given steps in
- * the given direction: <br />Button.WHEEL_DOWN, Button.WHEEL_UP
+ * move the mouse pointer to the given target location<br> and move the wheel the given steps in
+ * the given direction: <br>Button.WHEEL_DOWN, Button.WHEEL_UP
*
* @param <PatternFilenameRegionMatchLocation> target
* @param direction to move the wheel
@@ -2991,10 +2991,10 @@ public class Region {
}
/**
- * press and hold the given keys including modifier keys <br />use the key constants defined in
- * class Key, <br />which only provides a subset of a US-QWERTY PC keyboard layout <br />might be
+ * press and hold the given keys including modifier keys <br>use the key constants defined in
+ * class Key, <br>which only provides a subset of a US-QWERTY PC keyboard layout <br>might be
* mixed with simple characters
- * <br />use + to concatenate Key constants
+ * <br>use + to concatenate Key constants
*
* @param keys
*/
@@ -3150,8 +3150,8 @@ public class Region {
/**
* enters the given text one character/key after another using keyDown/keyUp
- * <br />about the usable Key constants see keyDown(keys) <br />Class Key only provides a subset
- * of a US-QWERTY PC keyboard layout<br />the text is entered at the current position of the
+ * <br>about the usable Key constants see keyDown(keys) <br>Class Key only provides a subset
+ * of a US-QWERTY PC keyboard layout<br>the text is entered at the current position of the
* focus/carret
*
* @param text containing characters and/or Key constants
@@ -3166,9 +3166,9 @@ public class Region {
}
/**
- * enters the given text one character/key after another using keyDown/keyUp<br />while holding
- * down the given modifier keys <br />about the usable Key constants see keyDown(keys) <br />Class
- * Key only provides a subset of a US-QWERTY PC keyboard layout<br />the text is entered at the
+ * enters the given text one character/key after another using keyDown/keyUp<br>while holding
+ * down the given modifier keys <br>about the usable Key constants see keyDown(keys) <br>Class
+ * Key only provides a subset of a US-QWERTY PC keyboard layout<br>the text is entered at the
* current position of the focus/carret
*
* @param text containing characters and/or Key constants
@@ -3186,9 +3186,9 @@ public class Region {
/**
* enters the given text one character/key after another using
*
- * keyDown/keyUp<br />while holding down the given modifier keys <br />about the usable Key
- * constants see keyDown(keys) <br />Class Key only provides a subset of a US-QWERTY PC keyboard
- * layout<br />the text is entered at the current position of the focus/carret
+ * keyDown/keyUp<br>while holding down the given modifier keys <br>about the usable Key
+ * constants see keyDown(keys) <br>Class Key only provides a subset of a US-QWERTY PC keyboard
+ * layout<br>the text is entered at the current position of the focus/carret
*
*
* @param text containing characters and/or Key constants
@@ -3210,10 +3210,10 @@ public class Region {
}
/**
- * first does a click(target) at the given target position to gain focus/carret <br />enters the
- * given text one character/key after another using keyDown/keyUp <br />about the usable Key
+ * first does a click(target) at the given target position to gain focus/carret <br>enters the
+ * given text one character/key after another using keyDown/keyUp <br>about the usable Key
* constants see keyDown(keys)
- * <br />Class Key only provides a subset of a US-QWERTY PC keyboard layout
+ * <br>Class Key only provides a subset of a US-QWERTY PC keyboard layout
*
* @param <PatternFilenameRegionMatchLocation> target
* @param text containing characters and/or Key constants
@@ -3226,9 +3226,9 @@ public class Region {
}
/**
- * first does a click(target) at the given target position to gain focus/carret <br />enters the
- * given text one character/key after another using keyDown/keyUp <br />while holding down the
- * given modifier keys<br />about the usable Key constants see keyDown(keys) <br />Class Key only
+ * first does a click(target) at the given target position to gain focus/carret <br>enters the
+ * given text one character/key after another using keyDown/keyUp <br>while holding down the
+ * given modifier keys<br>about the usable Key constants see keyDown(keys) <br>Class Key only
* provides a subset of a US-QWERTY PC keyboard layout
*
* @param <PatternFilenameRegionMatchLocation> target
@@ -3242,9 +3242,9 @@ public class Region {
}
/**
- * first does a click(target) at the given target position to gain focus/carret <br />enters the
- * given text one character/key after another using keyDown/keyUp <br />while holding down the
- * given modifier keys<br />about the usable Key constants see keyDown(keys) <br />Class Key only
+ * first does a click(target) at the given target position to gain focus/carret <br>enters the
+ * given text one character/key after another using keyDown/keyUp <br>while holding down the
+ * given modifier keys<br>about the usable Key constants see keyDown(keys) <br>Class Key only
* provides a subset of a US-QWERTY PC keyboard layout
*
* @param <PatternFilenameRegionMatchLocation> target
@@ -3312,7 +3312,7 @@ public class Region {
}
/**
- * pastes the text at the current position of the focus/carret <br />using the clipboard and
+ * pastes the text at the current position of the focus/carret <br>using the clipboard and
* strg/ctrl/cmd-v (paste keyboard shortcut)
*
* @param text a string, which might contain unicode characters
@@ -3327,8 +3327,8 @@ public class Region {
}
/**
- * first does a click(target) at the given target position to gain focus/carret <br /> and then
- * pastes the text <br /> using the clipboard and strg/ctrl/cmd-v (paste keyboard shortcut)
+ * first does a click(target) at the given target position to gain focus/carret <br> and then
+ * pastes the text <br> using the clipboard and strg/ctrl/cmd-v (paste keyboard shortcut)
*
* @param <PatternFilenameRegionMatchLocation> target
* @param text a string, which might contain unicode characters
@@ -3354,8 +3354,8 @@ public class Region {
//<editor-fold defaultstate="collapsed" desc="OCR - read text from Screen">
/**
- * STILL EXPERIMENTAL: tries to read the text in this region<br /> might contain misread
- * characters, NL characters and other stuff, when interpreting contained grafics as text<br />
+ * STILL EXPERIMENTAL: tries to read the text in this region<br> might contain misread
+ * characters, NL characters and other stuff, when interpreting contained grafics as text<br>
* Best results: one line of text with no grafics in the line
*
* @return the text read (utf8 encoded)
@@ -3378,10 +3378,10 @@ public class Region {
/**
* VERY EXPERIMENTAL: returns a list of matches, that represent single words, that have been found
- * in this region<br /> the match's x,y,w,h the region of the word<br /> Match.getText() returns
- * the word (utf8) at this match<br />
+ * in this region<br> the match's x,y,w,h the region of the word<br> Match.getText() returns
+ * the word (utf8) at this match<br>
* Match.getScore() returns a value between 0 ... 1, that represents some OCR-confidence value<br
- * /> (the higher, the better the OCR engine thinks the result is)
+ *> (the higher, the better the OCR engine thinks the result is)
*
* @return a list of matches
*/
diff --git a/API/src/main/java/org/sikuli/script/Screen.java b/API/src/main/java/org/sikuli/script/Screen.java
index 4cc257e..5dcb333 100755
--- a/API/src/main/java/org/sikuli/script/Screen.java
+++ b/API/src/main/java/org/sikuli/script/Screen.java
@@ -20,9 +20,9 @@ import java.awt.Rectangle;
* top left corner and the points contained in the screen area might have negative x and/or y values)
* <br >The screens are arranged in an array (index = id) and each screen is always the same object
* (not possible to create new objects).
- * <br />A screen inherits from class Region, so it can be used as such in all aspects. If you need
+ * <br>A screen inherits from class Region, so it can be used as such in all aspects. If you need
* the region of the screen more than once, you have to create new ones based on the screen.
- * <br />The so called primary screen is the one with top left (0,0) and has id 0.
+ * <br>The so called primary screen is the one with top left (0,0) and has id 0.
*/
public class Screen extends Region implements EventObserver, IScreen {
@@ -265,7 +265,7 @@ public class Screen extends Region implements EventObserver, IScreen {
/**
*
* @param id
- * @return the physical coordinate/size <br />as AWT.Rectangle to avoid mix up with getROI
+ * @return the physical coordinate/size <br>as AWT.Rectangle to avoid mix up with getROI
*/
public static Rectangle getBounds(int id) {
return gdevs[getValidID(id)].getDefaultConfiguration().getBounds();
@@ -273,7 +273,7 @@ public class Screen extends Region implements EventObserver, IScreen {
/**
* each screen has exactly one robot (internally used for screen capturing)
- * <br />available as a convenience for those who know what they are doing. Should not be needed
+ * <br>available as a convenience for those who know what they are doing. Should not be needed
* normally.
*
* @param id
diff --git a/API/src/main/java/org/sikuli/script/ScreenImage.java b/API/src/main/java/org/sikuli/script/ScreenImage.java
index 7a9b5e5..c9f8b6b 100755
--- a/API/src/main/java/org/sikuli/script/ScreenImage.java
+++ b/API/src/main/java/org/sikuli/script/ScreenImage.java
@@ -66,7 +66,6 @@ public class ScreenImage {
* if not yet stored before
*
* @return absolute path to stored file
- * @throws IOException
*/
public String getFile() {
if (_filename == null) {
@@ -81,7 +80,6 @@ public class ScreenImage {
*
* @param path valid path string
* @return absolute path to stored file
- * @throws IOException
*/
public String getFile(String path) {
try {
@@ -101,7 +99,6 @@ public class ScreenImage {
* @param path valid path string
* @param name filename (.png is added if not present)
* @return absolute path to stored file
- * @throws IOException
*/
public String getFile(String path, String name) {
if (name == null) {
diff --git a/Basics/src/main/java/org/sikuli/basics/Debug.java b/Basics/src/main/java/org/sikuli/basics/Debug.java
index 97dac26..75cfb12 100644
--- a/Basics/src/main/java/org/sikuli/basics/Debug.java
+++ b/Basics/src/main/java/org/sikuli/basics/Debug.java
@@ -13,15 +13,15 @@ import java.util.Date;
/**
* Debug is a utility class that wraps println statements and allows more or less command line
- * output to be turned on.<br /> <br /> For debug messages only ( Debug.log() ):<br /> Use system
- * property: sikuli.Debug to set the debug level (default = 1)<br /> On the command line, use
- * -Dsikuli.Debug=n to set it to level n<br /> -Dsikuli.Debug will disable any debug messages <br />
- * (which is equivalent to using Settings.Debuglogs = false)<br /> <br /> It prints if the level
- * number is less than or equal to the currently set DEBUG_LEVEL.<br /> <br /> For messages
- * ActionLogs, InfoLogs see Settings<br /> <br /> You might send all messages generated by this
- * class to a file:<br />-Dsikuli.Logfile=pathname (no path given: SikuliLog.txt in working
- * folder)<br /> This can be restricted to Debug.user only (others go to System.out):<br />
- * -Dsikuli.LogfileUser=pathname (no path given: UserLog.txt in working folder)<br />
+ * output to be turned on.<br> <br> For debug messages only ( Debug.log() ):<br> Use system
+ * property: sikuli.Debug to set the debug level (default = 1)<br> On the command line, use
+ * -Dsikuli.Debug=n to set it to level n<br> -Dsikuli.Debug will disable any debug messages <br>
+ * (which is equivalent to using Settings.Debuglogs = false)<br> <br> It prints if the level
+ * number is less than or equal to the currently set DEBUG_LEVEL.<br> <br> For messages
+ * ActionLogs, InfoLogs see Settings<br> <br> You might send all messages generated by this
+ * class to a file:<br>-Dsikuli.Logfile=pathname (no path given: SikuliLog.txt in working
+ * folder)<br> This can be restricted to Debug.user only (others go to System.out):<br>
+ * -Dsikuli.LogfileUser=pathname (no path given: UserLog.txt in working folder)<br>
*
* This solution is NOT threadsafe !!!
*/
@@ -178,7 +178,7 @@ public class Debug {
}
/**
- * Sikuli messages from actions like click, ...<br /> switch on/off: Settings.ActionLogs
+ * Sikuli messages from actions like click, ...<br> switch on/off: Settings.ActionLogs
*
* @param message (String or format string)
* @param args to use with format string
@@ -190,7 +190,7 @@ public class Debug {
}
/**
- * informative Sikuli messages <br /> switch on/off: Settings.InfoLogs
+ * informative Sikuli messages <br> switch on/off: Settings.InfoLogs
*
* @param message (String or format string)
* @param args to use with format string
@@ -202,7 +202,7 @@ public class Debug {
}
/**
- * Sikuli error messages<br /> switch on/off: always on
+ * Sikuli error messages<br> switch on/off: always on
*
* @param message (String or format string)
* @param args to use with format string
@@ -212,7 +212,7 @@ public class Debug {
}
/**
- * Sikuli debug messages with default level<br /> switch on/off: Settings.DebugLogs (off) and/or
+ * Sikuli debug messages with default level<br> switch on/off: Settings.DebugLogs (off) and/or
* -Dsikuli.Debug
*
* @param message (String or format string)
@@ -223,8 +223,8 @@ public class Debug {
}
/**
- * messages given by the user<br /> switch on/off: Settings.UserLogs<br /> depending on
- * Settings.UserLogTime, the prefix contains a timestamp <br /> the user prefix (default "user")
+ * messages given by the user<br> switch on/off: Settings.UserLogs<br> depending on
+ * Settings.UserLogTime, the prefix contains a timestamp <br> the user prefix (default "user")
* can be set: Settings,UserLogPrefix
*
* @param message (String or format string)
@@ -243,7 +243,7 @@ public class Debug {
}
/**
- * Sikuli debug messages with level<br /> switch on/off: Settings.DebugLogs (off) and/or
+ * Sikuli debug messages with level<br> switch on/off: Settings.DebugLogs (off) and/or
* -Dsikuli.Debug
*
* @param level
@@ -301,7 +301,7 @@ public class Debug {
}
/**
- * Sikuli profiling messages<br /> switch on/off: Settings.ProfileLogs, default off
+ * Sikuli profiling messages<br> switch on/off: Settings.ProfileLogs, default off
*
* @param message (String or format string)
* @param args to use with format string
@@ -323,7 +323,7 @@ public class Debug {
}
/**
- * start the timer<br /> usage: Debug timer = new Debug(); timer.startTiming(...)
+ * start the timer<br> usage: Debug timer = new Debug(); timer.startTiming(...)
*
* @param message (String or format string)
* @param args to use with format string
@@ -344,7 +344,7 @@ public class Debug {
}
/**
- * convenience: silently start timer<br /> usage: Debug timer = new Debug(); timer.start(); ...
+ * convenience: silently start timer<br> usage: Debug timer = new Debug(); timer.start(); ...
* timer.end();
*/
public void start() {
@@ -352,7 +352,7 @@ public class Debug {
}
/**
- * stop the timer and print message, if current debug level > default level
+ * stop the timer and print message, if current debug level > default level
*
* @param message
* @return the time in msec
diff --git a/Basics/src/main/java/org/sikuli/basics/FileManager.java b/Basics/src/main/java/org/sikuli/basics/FileManager.java
index e88eb27..40f3e81 100644
--- a/Basics/src/main/java/org/sikuli/basics/FileManager.java
+++ b/Basics/src/main/java/org/sikuli/basics/FileManager.java
@@ -65,17 +65,14 @@ public class FileManager {
private static final String EXECUTABLE = "#executable";
/**
- * System.load() the given library module <br />
- * from standard places (folder libs or SikuliX/libs) in the following order<br />
- * 1. -Dsikuli.Home=<br /> 2. Environement SIKULIX_HOME<br />
- * 3. parent folder of sikuli-script.jar (or main jar)<br />
- * 4. folder user's home (user.home)<br/>
- * 5. current working dir or parent of current working dir<br />
+ * System.load() the given library module <br>
+ * from standard places (folder libs or SikuliX/libs) in the following order<br>
+ * 1. -Dsikuli.Home=<br> 2. Environement SIKULIX_HOME<br>
+ * 3. parent folder of sikuli-script.jar (or main jar)<br>
+ * 4. folder user's home (user.home)<br>
+ * 5. current working dir or parent of current working dir<br>
* 6. standard installation places of Sikuli
*
- * @param libname
- * @param doLoad = true: load it here
- * @throws IOException
*/
public static void loadLibrary(String libname) {
if (nativeLoader == null) {
@@ -625,10 +622,10 @@ public class FileManager {
}
/**
- * Retrieves the actual script file<br /> - from a folder script.sikuli<br />
- * - from a folder script (no extension) (script.sikuli is used, if exists)<br /> - from a file
- * script.skl or script.zip (after unzipping to temp)<br /> - from a jar script.jar (after
- * preparing as extension)<br />
+ * Retrieves the actual script file<br> - from a folder script.sikuli<br>
+ * - from a folder script (no extension) (script.sikuli is used, if exists)<br> - from a file
+ * script.skl or script.zip (after unzipping to temp)<br> - from a jar script.jar (after
+ * preparing as extension)<br>
*
* @param scriptName one of the above.
* @return The File containing the actual script.
diff --git a/Basics/src/main/java/org/sikuli/basics/GifDecoder.java b/Basics/src/main/java/org/sikuli/basics/GifDecoder.java
index ce7349c..b562c71 100755
--- a/Basics/src/main/java/org/sikuli/basics/GifDecoder.java
+++ b/Basics/src/main/java/org/sikuli/basics/GifDecoder.java
@@ -19,7 +19,7 @@ import java.util.*;
* GifDecoder d = new GifDecoder();
* d.read("sample.gif");
* int n = d.getFrameCount();
- * for (int i = 0; i < n; i++) {
+ * for (int i = 0; i < n; i++) {
* BufferedImage frame = d.getFrame(i); // frame i
* int t = d.getDelay(i); // display duration of frame in milliseconds
* // do something with frame
@@ -268,7 +268,7 @@ public class GifDecoder {
/**
* Reads GIF image from stream
*
- * @param BufferedInputStream containing GIF file.
+ * @param is BufferedInputStream containing GIF file.
* @return read status code (0 = no errors)
*/
public int read(BufferedInputStream is) {
@@ -295,7 +295,7 @@ public class GifDecoder {
/**
* Reads GIF image from stream
*
- * @param InputStream containing GIF file.
+ * @param is InputStream containing GIF file.
* @return read status code (0 = no errors)
*/
public int read(InputStream is) {
diff --git a/Basics/src/main/java/org/sikuli/basics/IScriptRunner.java b/Basics/src/main/java/org/sikuli/basics/IScriptRunner.java
index b2f369e..2bd05c8 100644
--- a/Basics/src/main/java/org/sikuli/basics/IScriptRunner.java
+++ b/Basics/src/main/java/org/sikuli/basics/IScriptRunner.java
@@ -27,7 +27,6 @@ public interface IScriptRunner {
* @param scriptfile File containing the script
* @param imagedirectory Directory containing the images (might be null: parent of script)
* @param scriptArgs Arguments to be passed directly to the script with --args
- * @param isIDE script runner needs to know, wether called from Sikuli IDE
* @return exitcode for the script execution
*/
public int runScript(File scriptfile, File imagedirectory, String[] scriptArgs, String[] forIDE);
diff --git a/Basics/src/main/java/org/sikuli/basics/ResourceLoader.java b/Basics/src/main/java/org/sikuli/basics/ResourceLoader.java
index 4dedc7a..4f0f57f 100755
--- a/Basics/src/main/java/org/sikuli/basics/ResourceLoader.java
+++ b/Basics/src/main/java/org/sikuli/basics/ResourceLoader.java
@@ -752,8 +752,6 @@ public class ResourceLoader implements IResourceLoader {
* make sure, a native library is available and loaded
*
* @param libname System.loadLibrary() compatible library name
- * @return the extracted File object
- * @throws IOException
*/
public void loadLib(String libname) {
String memx = mem;
diff --git a/Basics/src/main/java/org/sikuli/basics/Settings.java b/Basics/src/main/java/org/sikuli/basics/Settings.java
index 36d5d2e..c188306 100644
--- a/Basics/src/main/java/org/sikuli/basics/Settings.java
+++ b/Basics/src/main/java/org/sikuli/basics/Settings.java
@@ -37,25 +37,25 @@ public class Settings {
*/
public static String OcrDataPath;
/**
- * standard place in the net to get information about extensions<br />
- * needs a file extensions.json with content<br />
- * {"extension-list":<br />
- * {"extensions":<br />
- * [<br />
- * {<br />
- * "name":"SikuliGuide",<br />
- * "version":"0.3",<br />
- * "description":"visual annotations",<br />
- * "imgurl":"somewhere in the net",<br />
- * "infourl":"http://doc.sikuli.org",<br />
- * "jarurl":"---extensions---"<br />
- * },<br />
- * ]<br />
- * }<br />
- * }<br />
- * imgurl: to get an icon from<br />
- * infourl: where to get more information<br />
- * jarurl: where to download the jar from (no url: this standard place)<br />
+ * standard place in the net to get information about extensions<br>
+ * needs a file extensions.json with content<br>
+ * {"extension-list":<br>
+ * {"extensions":<br>
+ * [<br>
+ * {<br>
+ * "name":"SikuliGuide",<br>
+ * "version":"0.3",<br>
+ * "description":"visual annotations",<br>
+ * "imgurl":"somewhere in the net",<br>
+ * "infourl":"http://doc.sikuli.org",<br>
+ * "jarurl":"---extensions---"<br>
+ * },<br>
+ * ]<br>
+ * }<br>
+ * }<br>
+ * imgurl: to get an icon from<br>
+ * infourl: where to get more information<br>
+ * jarurl: where to download the jar from (no url: this standard place)<br>
*/
public static String SikuliRepo;
private static String[] args = new String[0];
diff --git a/Basics/src/main/java/org/sikuli/basics/SikuliX.java b/Basics/src/main/java/org/sikuli/basics/SikuliX.java
index 8e081db..5d2d307 100644
--- a/Basics/src/main/java/org/sikuli/basics/SikuliX.java
+++ b/Basics/src/main/java/org/sikuli/basics/SikuliX.java
@@ -344,9 +344,9 @@ public class SikuliX {
}
/**
- * request user's input as one line of text <br />
- * with hidden = true: <br />
- * the dialog works as password input (input text hidden a s bullets) <br />
+ * request user's input as one line of text <br>
+ * with hidden = true: <br>
+ * the dialog works as password input (input text hidden a s bullets) <br>
* take care to destroy the return value as soon as possible (internally security is granted)
* @param msg
* @param preset
@@ -412,9 +412,9 @@ public class SikuliX {
}
/**
- * Shows a dialog request to enter text in a multiline text field <br />
- * Though not all text might be visible, everything entered is delivered with the returned text <br />
- * The main purpose for this feature is to allow pasting text from somewhere preserving line breaks <br />
+ * Shows a dialog request to enter text in a multiline text field <br>
+ * Though not all text might be visible, everything entered is delivered with the returned text <br>
+ * The main purpose for this feature is to allow pasting text from somewhere preserving line breaks <br>
* @param msg the message to display.
* @param title the title for the dialog (default: Sikuli input request)
* @param lines the maximum number of lines visible in the text field (default 9)
@@ -474,7 +474,7 @@ public class SikuliX {
/**
- * INTERNAL USE: convert ##--##Fri Jan 3 10:53:05 CET 2014##--## <br />
+ * INTERNAL USE: convert ##--##Fri Jan 3 10:53:05 CET 2014##--## <br>
* to: 2014-JAN-03-10:53:05 (timestamp of build)
* @param tsb
* @return
diff --git a/Basics/src/main/java/org/sikuli/basics/SikuliXforJython.java b/Basics/src/main/java/org/sikuli/basics/SikuliXforJython.java
index ecd9fef..b7758f0 100644
--- a/Basics/src/main/java/org/sikuli/basics/SikuliXforJython.java
+++ b/Basics/src/main/java/org/sikuli/basics/SikuliXforJython.java
@@ -13,9 +13,9 @@ import java.security.CodeSource;
/**
*
- * Can be used in pure Jython environments to add the Sikuli Python API to sys.path<br />
- * Usage: (before any Sikuli features are used)<br />
- * import org.sikuli.basics.SikuliXforJython<br />
+ * Can be used in pure Jython environments to add the Sikuli Python API to sys.path<br>
+ * Usage: (before any Sikuli features are used)<br>
+ * import org.sikuli.basics.SikuliXforJython<br>
* from sikuli import *
*/
public class SikuliXforJython {
diff --git a/Guide/src/main/java/org/sikuli/guide/ComponentMover.java b/Guide/src/main/java/org/sikuli/guide/ComponentMover.java
index fbcc785..40e9115 100644
--- a/Guide/src/main/java/org/sikuli/guide/ComponentMover.java
+++ b/Guide/src/main/java/org/sikuli/guide/ComponentMover.java
@@ -82,7 +82,7 @@ public class ComponentMover extends MouseAdapter{
* @param destinationClass the Class of the ancestor component
- * @param component the Components to be registered for forwarding
+ * @param components the Components to be registered for forwarding
* drag events to the ancestor Component.
@@ -222,7 +222,7 @@ public class ComponentMover extends MouseAdapter{
*
- * @param component the component the listeners are removed from
+ * @param components components the listeners are removed from
*/
@@ -244,7 +244,7 @@ public class ComponentMover extends MouseAdapter{
*
- * @param component the component the listeners are added to
+ * @param components components the listeners are added to
*/
diff --git a/Guide/src/main/java/org/sikuli/guide/SikuliGuideComponent.java b/Guide/src/main/java/org/sikuli/guide/SikuliGuideComponent.java
index 440d480..f0e3c74 100644
--- a/Guide/src/main/java/org/sikuli/guide/SikuliGuideComponent.java
+++ b/Guide/src/main/java/org/sikuli/guide/SikuliGuideComponent.java
@@ -88,7 +88,7 @@ public class SikuliGuideComponent extends JComponent
Color colorText;
/**
- * set a Java Color for the component<br />
+ * set a Java Color for the component<br>
* not all components have all color options
* @param all sets the color for all options (which have to be null in this case)
* @param front sets the foreground color
@@ -161,7 +161,6 @@ public class SikuliGuideComponent extends JComponent
/**
* set the front and back color as (r, g, b) integer array
- * @param color
*/
public SikuliGuideComponent setColor(int r, int g, int b) {
setColor(new Color(r, g, b));
@@ -179,7 +178,6 @@ public class SikuliGuideComponent extends JComponent
/**
* set text color as (r, g, b) integer array
- * @param color
*/
public SikuliGuideComponent setTextColor(int r, int g, int b) {
setTextColor(new Color(r, g, b));
diff --git a/IDE/pom.xml b/IDE/pom.xml
index a647eb8..0bad0da 100755
--- a/IDE/pom.xml
+++ b/IDE/pom.xml
@@ -67,6 +67,13 @@
</configuration>
</plugin>
<plugin>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <!-- has problems with excluded files; excluding doesn't work for me -->
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+ <plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
diff --git a/Jython/src/main/java/org/sikuli/jython/PythonIndentation.java b/Jython/src/main/java/org/sikuli/jython/PythonIndentation.java
index a29097d..e2a87b6 100755
--- a/Jython/src/main/java/org/sikuli/jython/PythonIndentation.java
+++ b/Jython/src/main/java/org/sikuli/jython/PythonIndentation.java
@@ -214,7 +214,7 @@ public class PythonIndentation {
* Sets the number of whitespace columns that equals a single tab used by
* this object to calculate the indentation of lines.
*
- * @param tabWidth
+ * @param tabwidth
* the number of whitespace columns that equals a single tab
*/
public void setTabWidth(int tabwidth){
diff --git a/Jython/src/main/java/org/sikuli/jython/PythonState.java b/Jython/src/main/java/org/sikuli/jython/PythonState.java
index 5fc3292..9164fff 100755
--- a/Jython/src/main/java/org/sikuli/jython/PythonState.java
+++ b/Jython/src/main/java/org/sikuli/jython/PythonState.java
@@ -587,9 +587,8 @@ public class PythonState {
* contents of any strings or parenthesised expression, and any comment (i.e.
* any input text with a nesting level greater than 0), and the trailing
* end-of-line character, are deleted.
- * <p>
- * Examples:
* <table border="1">
+ * <caption>Examples:</caption>
* <tr>
* <th>Input</th>
* <th>Structure</th>
@@ -616,7 +615,6 @@ public class PythonState {
* </tr>
* </table>
*
- * @return
*/
public String getLastLogicalLineStructure(){
return logicalLineStructure.toString();
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/sikuli.git
More information about the pkg-java-commits
mailing list