mirror of
https://github.com/bspeice/libcvautomation
synced 2024-12-04 13:58:11 -05:00
Fix Doxygen and rename some pages
This commit is contained in:
Bradlee Speice
parent
84383e2053
commit
a6fff5243f
@ -459,7 +459,7 @@ WARN_LOGFILE =
|
||||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = @top_srcdir@/include/@CV_VERSION@ @top_srcdir@/examples
|
||||
INPUT = @top_srcdir@/include/ @top_srcdir@/examples
|
||||
|
||||
# If the value of the INPUT tag contains directories, you can use the
|
||||
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
||||
|
||||
@ -26,17 +26,17 @@ endif
|
||||
if BUILD_MAN
|
||||
directory = $(top_srcdir)/docs/man/man3
|
||||
|
||||
dist_man_MANS = $(directory)/cvaPoint.3 $(directory)/libcvautomation.h.3 $(directory)/libcvautomation-xlib.h.3 $(directory)/libcv_search_methods.3 $(directory)/XTest_key_strings.3 $(directory)/cvautomationList.3 $(directory)/libcvautomation-opencv.h.3 $(directory)/libcvautomation-xtest.h.3 $(directory)/XTest_command_strings.3 $(directory)/libcvautomation.3 $(directory)/writing_app_tests.3 $(directory)/cva-match.3 $(directory)/cva-input.3
|
||||
dist_man_MANS = $(directory)/cvaPoint.3 $(directory)/libcvautomation.h.3 $(directory)/libcvautomation-xlib.h.3 $(directory)/libcvautomation_search_methods.3 $(directory)/xtest_key_strings.3 $(directory)/cvautomationList.3 $(directory)/libcvautomation-opencv.h.3 $(directory)/libcvautomation-xtest.h.3 $(directory)/xtest_command_strings.3 $(directory)/libcvautomation.3 $(directory)/writing_app_tests.3 $(directory)/cva-match.3 $(directory)/cva-input.3
|
||||
|
||||
$(directory)/cvaPoint.3: doxyfile.stamp
|
||||
$(directory)/libcvautomation.h.3: doxyfile.stamp
|
||||
$(directory)/libcvautomation-xlib.h.3: doxyfile.stamp
|
||||
$(directory)/libcv_search_methods.3: doxyfile.stamp
|
||||
$(directory)/XTest_key_strings.3: doxyfile.stamp
|
||||
$(directory)/libcvautomation_search_methods.3: doxyfile.stamp
|
||||
$(directory)/xtest_key_strings.3: doxyfile.stamp
|
||||
$(directory)/cvautomationList.3: doxyfile.stamp
|
||||
$(directory)/libcvautomation-opencv.h.3: doxyfile.stamp
|
||||
$(directory)/libcvautomation-xtest.h.3: doxyfile.stamp
|
||||
$(directory)/XTest_command_strings.3: doxyfile.stamp
|
||||
$(directory)/xtest_command_strings.3: doxyfile.stamp
|
||||
$(directory)/libcvautomation.3: doxyfile.stamp
|
||||
$(directory)/writing_app_tests.3: doxyfile.stamp
|
||||
$(directory)/cva-match.3: doxyfile.stamp
|
||||
|
||||
@ -62,7 +62,7 @@ void matchSubImage_a_location_center ( const char *rootImageFileName, cvautomati
|
||||
* \date 7/18/2012
|
||||
*/
|
||||
|
||||
/** \page libcv_search_methods Libcv Search Methods
|
||||
/** \page libcvautomation_search_methods Libcv Search Methods
|
||||
This page describes the methods libcv uses to search for a sub image in a root image.
|
||||
\section tolerance Tolerance Values
|
||||
Tolerance values are used to control how strict each of the following search methods are. Acceptable values are from \c INT_MIN to \c INT_MAX.
|
||||
@ -129,7 +129,7 @@ Formula:
|
||||
* \param subImage The sub image (in IplImage format) to search for in \c rootImage
|
||||
* \param searchMethod The search method to use when searching for \c subImage in \c rootImage.
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in \c rootImage.
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \return The location of the sub image in root image
|
||||
*/
|
||||
|
||||
@ -139,7 +139,7 @@ Formula:
|
||||
* \param subImage The sub image (in IplImage format) to search for in \c rootImage
|
||||
* \param searchMethod The search method to use when searching for \c subImage in \c rootImage.
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in \c rootImage.
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \return The center location of the sub image in root image
|
||||
*/
|
||||
|
||||
@ -150,7 +150,7 @@ Formula:
|
||||
* \param subImage_location The location of the sub image to search for in \c rootImage
|
||||
* \param searchMethod The search method to use when searching for \c subImage in \c rootImage.
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in \c rootImage.
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \return The location of the sub image in root image
|
||||
*/
|
||||
|
||||
@ -161,7 +161,7 @@ Formula:
|
||||
* \param subImage_location The location of the sub image to search for in \c rootImage
|
||||
* \param searchMethod The search method to use when searching for \c subImage in \c rootImage.
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in \c rootImage.
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \return The center location of the sub image in root image
|
||||
*/
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ CvPoint matchSubImage_X11_location_center( Display *displayLocation, const char
|
||||
* \param subImage The sub image (in IplImage format) to search for in the root X11 window
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of the sub image in root X11 window
|
||||
*/
|
||||
|
||||
@ -82,7 +82,7 @@ CvPoint matchSubImage_X11_location_center( Display *displayLocation, const char
|
||||
* \param subImage The sub image (in IplImage format) to search for in the root X11 window
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The center location of the sub image in the root X11 window
|
||||
*/
|
||||
|
||||
@ -93,7 +93,7 @@ CvPoint matchSubImage_X11_location_center( Display *displayLocation, const char
|
||||
* \param subImage_location The location of the sub image to search for in the root X11 window
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The center location of the sub image in the root X11 window
|
||||
*/
|
||||
|
||||
@ -104,7 +104,7 @@ CvPoint matchSubImage_X11_location_center( Display *displayLocation, const char
|
||||
* \param subImage_location The location of the sub image to search for in the root X11 window
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The center location of the sub image in the root X11 window
|
||||
*/
|
||||
|
||||
|
||||
@ -116,7 +116,7 @@ cvaPoint xte_commandString ( Display *displayLocation, char *commandString, int
|
||||
* \date 7/18/2012
|
||||
*/
|
||||
|
||||
/** \page XTest_key_strings XTest Key Strings
|
||||
/** \page xtest_key_strings XTest Key Strings
|
||||
This page describes the various extra key strings to use with X11.
|
||||
The following list is generated with this command:
|
||||
\code xmodmap -pke | cut -d'=' -f2 | sed 's/ /\n/g' | tr -s '\n' | awk '{ print length(), $0 | "sort -n" }' | cut -d' ' -f2 | uniq \endcode
|
||||
@ -365,7 +365,7 @@ XF86MonBrightnessDown
|
||||
\warning Please note that each key string above is first translated into a key code, and then into the actual key click. Thus, while you might intend to press "dollar", it will actually come out as "4". If you need a <tt>'$'</tt> to come out, use the <tt>'keystring $'</tt> command to \ref xte_commandString() or <tt>'key_str $'</tt> function in the BASH wrapper - see the \ref wrapper_functions.
|
||||
*/
|
||||
|
||||
/** \page XTest_command_strings xte_commandString() Command Strings
|
||||
/** \page xtest_command_strings xte_commandString() Command Strings
|
||||
This page describes the various command strings available for the \ref xte_commandString() function.
|
||||
\section mouseclick Mouse Click
|
||||
\code 'mouseclick <button_number>' \endcode
|
||||
@ -422,15 +422,15 @@ Scroll the mouse up 1 time - depending on window manager settings, etc., this ma
|
||||
|
||||
\section keyclick Key Button Click
|
||||
\code 'keyclick <key_name>' \endcode
|
||||
Push and release a keyboard key. This can be a key like \c 'a', \c 'b', or something fancy like \c 'space'. Please see \ref XTest_key_strings for a full list of special keys.
|
||||
Push and release a keyboard key. This can be a key like \c 'a', \c 'b', or something fancy like \c 'space'. Please see \ref xtest_key_strings for a full list of special keys.
|
||||
|
||||
\section keydown Key Button Down
|
||||
\code 'keydown <key_name>' \endcode
|
||||
Push down <em>but do not release</em> a keyboard key. This can be a key like \c 'a', \c 'b', or something fancy like \c 'space'. Please see \ref XTest_key_strings for a full list of special keys.
|
||||
Push down <em>but do not release</em> a keyboard key. This can be a key like \c 'a', \c 'b', or something fancy like \c 'space'. Please see \ref xtest_key_strings for a full list of special keys.
|
||||
|
||||
\section keyup Key Button Up
|
||||
\code 'keyup <key_name>' \endcode
|
||||
Release a keyboard key. This can be a key like \c 'a', \c 'b', or something fancy like \c 'space'. Please see \ref XTest_key_strings for a full list of special keys.
|
||||
Release a keyboard key. This can be a key like \c 'a', \c 'b', or something fancy like \c 'space'. Please see \ref xtest_key_strings for a full list of special keys.
|
||||
|
||||
\section keystring Keyboard Input String
|
||||
\code 'keystring <string>' \endcode
|
||||
@ -491,7 +491,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param mouseButton The mouse button to click
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked.
|
||||
*/
|
||||
|
||||
@ -503,7 +503,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param mouseButton The mouse button to click
|
||||
* \param searchMethod The search method to use when searching for the sub image in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for the sub image in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked.
|
||||
*/
|
||||
|
||||
@ -515,7 +515,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param mouseButton The mouse button to click
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked.
|
||||
*/
|
||||
|
||||
@ -527,7 +527,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param mouseButton The mouse button to click
|
||||
* \param searchMethod The search method to use when searching for the sub image in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for the sub image in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was clicked. This will be (-1,-1) if there was an error, in which case the mouse will not have been clicked.
|
||||
*/
|
||||
|
||||
@ -552,7 +552,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param subImage The sub image (in IplImage format) to find in the root X11 window
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved.
|
||||
*/
|
||||
|
||||
@ -563,7 +563,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param filename The file name from which to load the sub-image
|
||||
* \param searchMethod The search method to use when searching for the sub image in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for the sub image in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved.
|
||||
*/
|
||||
|
||||
@ -574,7 +574,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param subImage The sub image (in IplImage format) to find in the root X11 window
|
||||
* \param searchMethod The search method to use when searching for \c subImage in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for \c subImage in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved.
|
||||
*/
|
||||
|
||||
@ -585,7 +585,7 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
* \param fileName The file name from which to load the sub-image
|
||||
* \param searchMethod The search method to use when searching for the sub image in the root X11 window
|
||||
* \param tolerance The tolerance to use when searching for the sub image in the root X11 window
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
* \returns The location of where the mouse was moved. This will be (-1,-1) if there was an error, in which case the mouse will not have been moved.
|
||||
*/
|
||||
|
||||
@ -621,10 +621,10 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
|
||||
/** \fn void xte_clickKey ( Display *displayLocation, char *key );
|
||||
* \brief Press and release a keyboard key
|
||||
* \details This method allows you to press and release a key, where the key may be \c 'a', \c 'b', or maybe something fancy like \c 'space'. Please see \ref XTest_key_strings for a full list of keys.
|
||||
* \details This method allows you to press and release a key, where the key may be \c 'a', \c 'b', or maybe something fancy like \c 'space'. Please see \ref xtest_key_strings for a full list of keys.
|
||||
* \param displayLocation The Display of which to click a key
|
||||
* \param key The key to click as a string
|
||||
* \see \ref XTest_key_strings
|
||||
* \see \ref xtest_key_strings
|
||||
*/
|
||||
|
||||
/** \fn void xte_clickKeyStr ( Display *displayLocation, char *string );
|
||||
@ -636,28 +636,28 @@ Input a string of text to the X11 server. For example, inputting 'Hello, world!"
|
||||
|
||||
/** \fn void xte_keyDown ( Display *displayLocation, char *key );
|
||||
* \brief Press a key down, but do not release it
|
||||
* \details This method allows you to push down a key, where the key may be \c 'a', \c 'b', or maybe something fancy like \c 'space'. Please see \ref XTest_key_strings for a full list of keys.
|
||||
* \details This method allows you to push down a key, where the key may be \c 'a', \c 'b', or maybe something fancy like \c 'space'. Please see \ref xtest_key_strings for a full list of keys.
|
||||
* \param displayLocation The Display of which to push down a key
|
||||
* \param key The key to click as a string
|
||||
* \see \ref XTest_key_strings
|
||||
* \see \ref xtest_key_strings
|
||||
*/
|
||||
|
||||
/** \fn void xte_keyUp ( Display *displayLocation, char *key );
|
||||
* \brief Release a key
|
||||
* \details This method allows you to release a key, where the key may be \c 'a', \c 'b', or maybe something fancy like \c 'space'. Please see \ref XTest_key_strings for a full list of keys.
|
||||
* \details This method allows you to release a key, where the key may be \c 'a', \c 'b', or maybe something fancy like \c 'space'. Please see \ref xtest_key_strings for a full list of keys.
|
||||
* \param displayLocation The Display of which to release a key
|
||||
* \param key The key to click as a string
|
||||
* \see \ref XTest_key_strings
|
||||
* \see \ref xtest_key_strings
|
||||
*/
|
||||
|
||||
/** \fn cvaPoint xte_commandString ( Display *displayLocation, char *commandString, int mouseButton, int searchMethod, int tolerance );
|
||||
* \brief Execute a command where the command is coming from a string
|
||||
* \details This function allows you to input a command to libcvautomation from a string. For example, to click a mouse button, you would use the \c command 'mouseclick'. Please note that some <tt>command</tt>s may need arguments to the string, and some may use function arguments. See \ref XTest_command_strings for a full list of command and arguments
|
||||
* \details This function allows you to input a command to libcvautomation from a string. For example, to click a mouse button, you would use the \c command 'mouseclick'. Please note that some <tt>command</tt>s may need arguments to the string, and some may use function arguments. See \ref xtest_command_strings for a full list of command and arguments
|
||||
* \param displayLocation The Display of which to operate on
|
||||
* \param commandString The command string to execute - limit to \ref COMMAND_STR_LEN characters
|
||||
* \param mouseButton The mouse button to click if it is needed by the command being executed
|
||||
* \param searchMethod The search method to use if it is needed by the command being executed
|
||||
* \param tolerance The tolerance to use if it is needed by the command being executed
|
||||
* \see \ref XTest_command_strings
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref xtest_command_strings
|
||||
* \see \ref libcvautomation_search_methods
|
||||
*/
|
||||
|
||||
@ -262,11 +262,11 @@ typedef struct {
|
||||
* <ul>
|
||||
* <li>Set the \c SEARCH_METHOD
|
||||
* <ul>
|
||||
* <li>This value adjusts how libcvautomation searches for sub-images. See \ref libcv_search_methods for more information on accepted values, and how each works.
|
||||
* <li>This value adjusts how libcvautomation searches for sub-images. See \ref libcvautomation_search_methods for more information on accepted values, and how each works.
|
||||
* </ul>
|
||||
* <li>Set the \c TOLERANCE
|
||||
* <ul>
|
||||
* <li>This value adjusts how strict libcvautomation is when trying to find a sub-image. See \ref libcv_search_methods for more information on how to control how libcvautomation searches for images.
|
||||
* <li>This value adjusts how strict libcvautomation is when trying to find a sub-image. See \ref libcvautomation_search_methods for more information on how to control how libcvautomation searches for images.
|
||||
* </ul>
|
||||
* <li>Set \c USE_SANE_TOLERANCE
|
||||
* <ul>
|
||||
@ -361,17 +361,17 @@ typedef struct {
|
||||
*
|
||||
* \code key_down "<key-name>" \endcode
|
||||
* Press a key down and leave it down
|
||||
* \note This function accepts special keys like "Space" - see \ref XTest_key_strings for a full list of characters allowed.
|
||||
* \note This function accepts special keys like "Space" - see \ref xtest_key_strings for a full list of characters allowed.
|
||||
* <br><br>
|
||||
*
|
||||
* \code key_up "<key-name>" \endcode
|
||||
* Release a key
|
||||
* \note This function accepts special keys like "Space" - see \ref XTest_key_strings for a full list of characters allowed.
|
||||
* \note This function accepts special keys like "Space" - see \ref xtest_key_strings for a full list of characters allowed.
|
||||
* <br><br>
|
||||
*
|
||||
* \code key_click "<key-name>" \endcode
|
||||
* Press a key down and then release it immediately after
|
||||
* \note This function accepts special keys like "Space" - see \ref XTest_key_strings for a full list of characters allowed.
|
||||
* \note This function accepts special keys like "Space" - see \ref xtest_key_strings for a full list of characters allowed.
|
||||
* <br><br>
|
||||
*
|
||||
* \section appendix_utilities Useful extras
|
||||
@ -404,7 +404,7 @@ typedef struct {
|
||||
* \param resultPoint Holder for a result - for example, storing where this sub image was located in its root image
|
||||
* \param searchMethod The search method to use when searching for this sub image in a root image
|
||||
* \param tolerance The tolerance to use when searching for this sub image in a root image
|
||||
* \see \ref libcv_search_methods
|
||||
* \see \ref libcvautomation_search_methods
|
||||
*/
|
||||
|
||||
/** \struct cvaPoint
|
||||
|
||||
Loading…
Reference in New Issue
Block a user