mirror-github-bspeice/libcvautomation
1
0
Fork 0
mirror of https://github.com/bspeice/libcvautomation synced 2025-07-04 23:35:29 -04:00
Code Issues Releases Wiki Activity

Put in a warning about using waitfor without a tolerance value

Browse Source
This commit is contained in:
Bradlee Speice
2012-07-20 14:02:52 -04:00
parent bf0e01bb66
commit 77beb217d3
3 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/libcvautomation/libcvautomation.h.in
View File

@ -24,6 +24,7 @@
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <limits.h>
/* Autoconf logic to select the correct OpenCV version */
@cv_headers@
@ -297,6 +298,7 @@ typedef struct {
* TIMEOUT \endcode
* These control how the "waitfor" function is used. By default, all image-matching functions will wait for an image to appear, and then click on it. This way, it won't click randomly if it can or can't find an image, and provides very easy error recognition. The functions will wait for a period of \c TIMEOUT seconds before complaining.
* To disable waiting before performing an action, set \code USE_WAIT="" \endcode
* \warning Without setting a tolerance value, the waitfor function becomes totally useless, as the first search will always find an image. <tt>Make sure to set the tolerance</tt> (or just leave it as the default value in the wrapper).
*
* \subsection appendix_output Output and Debugging
* \code OUTFILE