Integrate documentation into the build process

2024-12-04 13:58:11 -05:00 · 2012-07-11 14:34:26 -04:00 · 2012-07-11 14:34:26 -04:00 · eddd689c29
commit eddd689c29
parent 2f7864d344
10 changed files with 397 additions and 10 deletions
--- a/Makefile.am
+++ b/Makefile.am
@ -1 +1 @@
-SUBDIRS = libcvautomation examples
+SUBDIRS = libcvautomation examples docs
--- a/configure.ac
+++ b/configure.ac
@ -31,15 +31,19 @@ AC_PATH_X
 #Configure OpenCV - version 2+ breaks a lot of things
 PKG_CHECK_MODULES([OpenCV], [opencv >= 2.0.0], [use_opencv2=true], [use_opencv1=true])
 AM_CONDITIONAL(USEOPENCV2, [test "$use_opencv2" != ""])
+#Let doxygen know where our headers are at
+AC_SUBST(INPUT_PATH, "../include/opencv2")
 if test "$use_opencv1" != ""; then
 	echo "could not find OpenCV version 2.0.0 or higher, checking for 1.0.0 or higher..."
 	PKG_CHECK_MODULES([OpenCV], [opencv >= 1.0.0])
+	#Update doxygen on where our headers are at
+	AC_SUBST(INPUT_PATH, "../include/opencv1")
 fi

 PKG_CHECK_MODULES([X11], [x11 >= 1.0.3])
 PKG_CHECK_MODULES([XTest], [xtst >= 0.21])

-AC_ARG_WITH(examples, [  --with-examples         build example programs '['default=yes']'])
+AC_ARG_WITH(examples, [  --with-examples         build example programs @<:@default=yes@:>@])

 AM_CONDITIONAL(BUILD_EXAMPLES, [test "$with_examples" != "no"])
 if test "$with_examples" != "no"; then
@ -47,9 +51,33 @@ if test "$with_examples" != "no"; then
 	AC_CHECK_HEADERS([limits.h stdlib.h unistd.h])
 fi

-# Checks for typedefs, structures, and compiler characteristics.
+# Check for doxygen
+AC_ARG_WITH(docs, [  --with-documentation    build documentation for libcvautomation @<:@default=yes@:>@])
+AC_ARG_ENABLE(man, [  --enable-man            enable building the 'man' pages for libcvautomation @<:@default=enable@:>@])
+AC_ARG_ENABLE(tex, [  --enable-tex            enable building the 'latex' pages for libcvautomation @<:@default=enable@:>@])
+if test "$with_docs" != "no"; then
+	AC_CHECK_PROGS([Doxygen], [doxygen])
+	if test -z "$Doxygen"; then
+		AC_MSG_WARN([Doxygen not found - continuing without building documentation.])
+	fi
+
+	AM_CONDITIONAL(BUILD_DOXYGEN, [test "$with_docs" != "no"])
+	AM_COND_IF(BUILD_DOXYGEN, [AC_CONFIG_FILES([docs/Doxyfile])])
+
+	#Check if we should generate man pages
+	if test "$enable_man" != "no"; then
+		AC_SUBST(ENABLE_MAN, YES)
+		AM_CONDITIONAL(BUILD_MAN, [test "$enable_man" != "no"])
+	fi
+
+	#Check if we should build Tex pages
+	if test "$enable_tex" != "no"; then
+		AC_SUBST(ENABLE_TEX, YES)
+		AM_CONDITIONAL(BUILD_TEX, [test "$enable_tex" != "no"])
+	fi
+fi

 # Checks for library functions.
 AC_FUNC_MALLOC

-AC_OUTPUT([Makefile] [libcvautomation/Makefile] [examples/Makefile])
+AC_OUTPUT([Makefile] [libcvautomation/Makefile] [examples/Makefile] [docs/Makefile])
--- a/documentation/Doxyfile
+++ b/documentation/Doxyfile
@ -17,13 +17,13 @@
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.

-PROJECT_NAME           = libcvautomation
+PROJECT_NAME           = @PACKAGE_NAME@

 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.

-PROJECT_NUMBER         = 1.0
+PROJECT_NUMBER         = @PACKAGE_VERSION@

 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@ -459,7 +459,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.

-INPUT                  = ../include/opencv2 ../libcvautomation
+INPUT                  = @INPUT_PATH@

 # 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 
@ -751,7 +751,7 @@ FORMULA_TRANSPARENT		= YES
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
 # generate Latex output.

-GENERATE_LATEX         = YES
+GENERATE_LATEX         = @ENABLE_TEX@

 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
@ -869,7 +869,7 @@ RTF_EXTENSIONS_FILE    =
 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
 # generate man pages

-GENERATE_MAN           = YES
+GENERATE_MAN           = @ENABLE_MAN@

 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@ -0,0 +1,44 @@
+if BUILD_DOXYGEN
+
+EXTRA_DIST = html
+install-data-local:
+	$(MKDIR_P) $(DESTDIR)$(datadir)/$(PACKAGE)/html
+	for f in html/*; do \
+		$(INSTALL_DATA) $(srcdir)/$$f \
+		$(DESTDIR)$(datadir)/$(PACKAGE)/html; done
+
+uninstall-local:
+	rm $(DESTDIR)$(datadir)/$(PACKAGE)/html/*
+	-rmdir $(DESTDIR)$(datadir)/$(PACKAGE)/html
+
+doxyfile.stamp:
+	$(Doxygen) Doxyfile
+	echo Timestamp > doxyfile.stamp
+
+CLEANFILES = doxyfile.stamp
+
+all-local: doxyfile.stamp
+clean-local:
+	rm -rf $(top_srcdir)/docs/man $(top_srcdir)/docs/html $(top_srcdir)/docs/latex
+
+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)/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)/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)/libcvautomation.3: doxyfile.stamp
+$(directory)/writing_app_tests.3: doxyfile.stamp
+
+endif
+
--- a/documentation/images/print-helpbutton.png
+++ b/documentation/images/print-helpbutton.png
--- a/documentation/images/print-printbutton1.png
+++ b/documentation/images/print-printbutton1.png
--- a/documentation/images/print-printbutton2.png
+++ b/documentation/images/print-printbutton2.png
--- a/include/opencv1/libcvautomation/libcvautomation-xtest.h
+++ b/include/opencv1/libcvautomation/libcvautomation-xtest.h
@ -365,7 +365,6 @@ This page describes the various command strings available for the \ref xte_comma
 \section mouseclick Mouse Click
 \code 'mouseclick <button_number>' \endcode
 Click the mouse button \c <button_number> in-place.
-\warning This command has no arguments.

 \section imouseclick Image Mouse Click
 \code 'imouseclick <image_name>' \endcode
--- a/include/opencv1/libcvautomation/libcvautomation.h
+++ b/include/opencv1/libcvautomation/libcvautomation.h
@ -65,6 +65,305 @@ typedef struct {
 * \date 6/21/2012
 */

+/** \mainpage Libcvautomation
+ * \author Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>
+ * \date 7/11/2012
+ * \section intro Introduction
+ * Welcome to Libcvautomation!
+ * Libcvautomation is a GUI automation and testing tool based on image recognition and response. This program was designed as a direct replacement for <a href="http://sikuli.org">Sikuli</a> and <a href="https://wiki.ubuntu.com/Xpresser">Xpresser</a>. I was having incredible difficulty getting either of these solutions to work - Sikuli would crash whenever I tried to take a screenshot, and Xpresser was both too new for our RHEL 5 systems, but also died, or didn't work, or something else. I really liked the way each of these programs approached GUI automation, but they simply didn't work. Additionally, I wanted to create a simple solution - it does what you want it to, and that's it.
+ * \section how_it_works How Libcvautomation Works
+ * Libcvautomation represents two software products coming together - <a href="http://opencv.willowgarage.com/wiki/">OpenCV</a> and the <a href="http://www.x.org/docs/Xext/xtest.pdf">XTest extension</a> to the X11 server. OpenCV is used for image recognition, and XTest is used to actually drive the X server. You can dig into \ref libcvautomation-xtest.h to get an idea of what all this library is capable of. <br>
+ * Basically what happens is that for whenever you need to do image recognition, OpenCV is used to find the images, and XTest is used to generate any events needed. Libcvautomation is mostly a wrapper to integrate both of these products, but also adds some functions like matchSubImage_X11() that allow you to match an image against the X11 root window in place. This means no more <tt>'xwd | convert "<out_name>"'</tt>.
+ * \section using Using Libcvautomation
+ * So how does one go about using libcvautomation? <br>
+ * I'm so glad you asked! I've provided a few reference programs - \c cva-match and \c cva-input - that can be used to demonstrate most of libcvautomation's capabilities. I've even provided a BASH wrapper to make it incredibly easy to use BASH with libcvautomation as well (requires that cva-match and cva-input are installed). Python bindings are on their way too. <br>
+ * Finally, if you want to know how to write your own application tests, please see \ref writing_app_tests for more information on that.
+ * \section questions Questions? Comments? Concerns?
+ * Please send any feedback to <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>. Pull requests can be submitted to <a href="https://github.com/DjBushido/cvautomation">my github repository</a>.*/
+
+/** \page libcvautomation Libcvautomation
+ * \author Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>
+ * \date 7/11/2012
+ * \section intro Introduction
+ * Welcome to Libcvautomation!
+ * Libcvautomation is a GUI automation and testing tool based on image recognition and response. This program was designed as a direct replacement for <a href="http://sikuli.org">Sikuli</a> and <a href="https://wiki.ubuntu.com/Xpresser">Xpresser</a>. I was having incredible difficulty getting either of these solutions to work - Sikuli would crash whenever I tried to take a screenshot, and Xpresser was both too new for our RHEL 5 systems, but also died, or didn't work, or something else. I really liked the way each of these programs approached GUI automation, but they simply didn't work. Additionally, I wanted to create a simple solution - it does what you want it to, and that's it.
+ * \section how_it_works How Libcvautomation Works
+ * Libcvautomation represents two software products coming together - <a href="http://opencv.willowgarage.com/wiki/">OpenCV</a> and the <a href="http://www.x.org/docs/Xext/xtest.pdf">XTest extension</a> to the X11 server. OpenCV is used for image recognition, and XTest is used to actually drive the X server. You can dig into \ref libcvautomation-xtest.h to get an idea of what all this library is capable of. <br>
+ * Basically what happens is that for whenever you need to do image recognition, OpenCV is used to find the images, and XTest is used to generate any events needed. Libcvautomation is mostly a wrapper to integrate both of these products, but also adds some functions like matchSubImage_X11() that allow you to match an image against the X11 root window in place. This means no more <tt>'xwd | convert "<out_name>"'</tt>.
+ * \section using Using Libcvautomation
+ * So how does one go about using libcvautomation? <br>
+ * I'm so glad you asked! I've provided a few reference programs - \c cva-match and \c cva-input - that can be used to demonstrate most of libcvautomation's capabilities. I've even provided a BASH wrapper to make it incredibly easy to use BASH with libcvautomation as well (requires that cva-match and cva-input are installed). Python bindings are on their way too. <br>
+ * Finally, if you want to know how to write your own application tests, please see \ref writing_app_tests for more information on that.
+ * \section questions Questions? Comments? Concerns?
+ * Please send any feedback to <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>. Pull requests can be submitted to <a href="https://github.com/DjBushido/cvautomation">my github repository</a>.
+ */
+
+/** \page writing_app_tests Writing Application Tests
+ * \author Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>
+ * \date 7/11/2012
+ * \section audience Audience
+ * <ul>
+ * <li>This document was written for people with some intermediate knowledge of BASH.
+ * <li>Screenshot experience is required - being able to create screenshots of windows using <a href="http://www.gimp.org/">GIMP</a>, the \c import command from <a href="http://www.imagemagick.org/script/index.php">ImageMagick</a>, or something similar. <br>
+ * <li>Required for working with libcvautomation internals (not needed strictly for writing application testing):
+ * 		<ul>
+ * 		<li>Intermediate-level C knowledge required for interfacing with libcvautomation. There isn't much complicated going on with libcvautomation itself, but you need to know to use cvaOpenDisplay() for grabbing a display and then cvaCloseDisplay() for closing it later for example.
+ * 		<li>C++ is available, but currently only as <tt>extern "C"</tt> style bindings.
+ * 		<li>Python bindings are in progress as of time-of-writing
+ * 		</ul>
+ * </ul>
+ *
+ * \section purpose Purpose
+ * <ul>
+ * <li>This document is intended to outline the libcvautomation testing library for GUI applications and its two reference programs \c cva-match and \c cva-input
+ * <li>These programs allow you to automate mouse and keyboard events in response to what appears on screen - for example, clicking a button based on an image of that button on screen.
+ * </ul>
+ *
+ * \section using Using Libcvautomation
+ * <ul>
+ * <li>Since libcvautomation is a shared-object library intended to bundle a lot of functionality in one area, we must use external programs to agin access to the functions of libcvautomation.
+ * <li>Two reference programs have been included to make this easy - \c cva-match and \c cva-input
+ * <li>The reference programs are fairly full-featured, and expose most of libcvautomation:
+ * 		<ul>
+ * 		<li>\c cva-match allows you to match multiple image files against a root image providing very fine control over how specific the match is
+ * 		<li>\c cva-input allows you to drive the X11 server using the XTest extension - for example, clicking on a button from image, clicking a key on the keyboard, and more.
+ * 		</ul>
+ * <li>These two programs should implement all functionality needed for GUI automation. Please contact <a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a> if you have suggestions for extra functionality, patches, comments, etc.
+ * <li>Finally, if you want to write your own programs using libcvautomation, the headers are located on your system. Use:
+ * \code #include <libcvautomation/libcvautomation.h> \endcode
+ * to include all necessary header files. See the "Files" tab above to get an idea of what functionality exists.
+ * \note Intermediate C or C++ knowledge is required for programming with libcvautomation. C++ is currently only supported through <tt>extern "C"</tt>, and full C++ bindings are not currently planned. Libcvautomation itself is incredibly simple, but interfaces with a few API's (Xlib, libcv) that it is helpful to have an idea of how to use.
+ *
+ * \section testing Application Testing
+ * Now we get into the good stuff. The basic process for application testing is as follows:
+ * <ul>
+ * <li>Create a sequence of screenshots for all mouse-clicks
+ * <li>Create a testing wrapper in BASH for automating the application
+ * <li>Test the wrapper and tune any necessary options
+ * </ul>
+ * \subsection screenshot_sequence Creating the Screenshot Sequence
+ * <ul>
+ * <li>This process creates a set of screenshots by which libcvautomation can drive the X11 server
+ * <li>The process is simple - create a screenshot of all buttons you would like to click in an application test, or location where you would like to move the mouse, etc.
+ * <li>This can be accomplished a number of different ways - using GIMP, the \c import command, or any other screenshot program. Additionally, libcvautomation will support any image format that OpenCV does. At the time of writing, these are:
+ * 		<ul>
+ * 		<li>Windows bitmaps - <tt>*.bmp</tt>, <tt>*.dib</tt>
+ * 		<li>JPEG files - <tt>*.jpeg</tt>, <tt>*.jpg</tt>, <tt>*.jpe</tt>
+ * 		<li>JPEG 2000 files - <tt>*.jp2</tt>
+ * 		<li>Portable Network Graphics - <tt>*.png</tt>
+ * 		<li>Portable image format - <tt>*.pbm</tt>, <tt>*.pgm</tt>, <tt>*.ppm</tt>
+ * 		<li>Sun rasters - <tt>*.sr</tt>, <tt>*.ras</tt>
+ * 		<li>TIFF files - <tt>*.tiff</tt>, <tt>*.tif</tt>
+ * 		</ul>
+ * <br>
+ * <li>Some tips on creating screenshots:
+ *		<ul>
+ *		<li>Use as distinct an image as possible in a screenshot. For example, the following images look very similar, but can do very different things:
+ *	 	\image html print-printbutton1.png 
+ *	 	<br>
+ *	 	\image html print-helpbutton.png
+ *		<ul>
+ *			<li>The large amount of grey-space in each of the images can be very confusing. While the text itself is different, the overwhelming amount of grey space can result in a false positive. Limiting the space of the screenshot can be useful:
+ *			\image html print-printbutton2.png
+ *			<br>
+ *			\image html print-helpbutton.png
+ *			<li>Limiting the button size in this case helps the program identify what button you want to click, but in general you want to include as much detail as possible.
+ *		</ul>
+ *		<br>
+ *		<li>Be careful of where an image may appear multiple times in a screenshot. For example, a "Help" button on a dialog may get confused with the "Help" menu at the top of the screen.
+ * </ul>
+ *
+ * \subsection testing_wrapper Create a Testing Wrapper
+ * <ul>
+ * <li>This is where the BASH knowledge comes into play. We are going to write a script that will run your application test, to make sure that the GUI is functioning correctly.
+ * <li>The following is the (strongly) recommended process, but is not strictly necessary to follow this. The way I'm going to explain this is by giving an example test I wrote, and explain what is going on:
+ * \code
+ * #!/bin/bash
+ * #This is an application test involving libcvautomation and libreoffice
+ * . libcvautomation_funcs
+ *
+ * #Changing any wrapper parameters should go here
+ *
+ *
+ * start_libreoffice_writer ()
+ * {
+ *	click_i "screens/gnome-1_menu.png" "screens/kde-1_menu.png" && sleep 1
+ *	click_i "screens/gnome-2_officeMenu.png" "screens/kde-2_officeMenu.png" && sleep 1
+ *	hover_i "screens/gnome-3_LibreOfficeWriter.png" "screens/kde-3_LibreOfficeWriter.png"
+ *	jiggle_mouse
+ *	click
+ *	sleep 30
+ * }
+ *
+ * close_libreoffice_writer()
+ * {
+ * 	click_i "screens/gnome-4_fileMenu.png" "screens/kde-4_fileMenu.png" && sleep 1
+ * 	click_i "screens/gnome-5_fileExit.png" "screens/kde-5_fileExit.png" && sleep 1
+ * 	click_i "screens/gnome-6_discard.png" "screens/kde-6_discard.png" && sleep 1
+ * }
+ *
+ * start_libreoffice_writer
+ * close_libreoffice_writer
+ * \endcode
+ * <br>
+ * \code
+ * #!/bin/bash
+ * #This is an application test involving libcvautomation and libreoffice
+ * . libcvautomation_funcs
+ * #Changing any wrapper parameters should go here
+ * \endcode
+ * <li>The purpose of these lines is just the standard BASH header. Additionally, we import a wrapper created for libcvautomation to make our job easier. Please note that the wrapper is included at the top of the source tree, you may need to copy it somewhere in order to use it. The wrapper itself is a handful of macros used to make our job easy.
+ * <li>Changing any wrapper parameters should go after sourcing the wrapper functions. See below on \ref testing_test_wrapper for more information.
+ * <br><br>
+ * \code
+ * start_libreoffice_writer ()
+ * {
+ *	click_i "screens/gnome-1_menu.png" "screens/kde-1_menu.png" && sleep 1
+ *	click_i "screens/gnome-2_officeMenu.png" "screens/kde-2_officeMenu.png" && sleep 1
+ *	hover_i "screens/gnome-3_LibreOfficeWriter.png" "screens/kde-3_LibreOfficeWriter.png"
+ *	jiggle_mouse
+ *	click
+ *	sleep 30
+ * }
+ * \endcode
+ * <li>This is the actual body of work done by libcvautomation
+ * <li>\c click_i is a function to click the mouse at an image - in this case, the gnome or kde menu.
+ * 		<ul>
+ *		<li>Because of how the cva-input program is designed, you can give it multiple images, and it will only select the one currently available. See \ref testing_test_wrapper for more information on how to use this (TOLERANCE specifically)
+ * 		<li>By using the function \c click_i, we make things a bit more readable - the full command line is <tt>cva-input -s 'icmouseclick <filename>'</tt>
+ * 		<li>See \ref wrapper_functions for a list of all functions available in the wrapper.
+ * 		</ul>
+ * <li>\c hover_i is a function to move the mouse to an image - in this case, move it over the LibreOffice menu item.
+ * <li>Then we jiggle the mouse to make sure that the item activates, click, and wait for the program to start up.
+ * <br><br>
+ * \code
+ * close_libreoffice_writer()
+ * {
+ * 	click_i "screens/gnome-4_fileMenu.png" "screens/kde-4_fileMenu.png" && sleep 1
+ * 	click_i "screens/gnome-5_fileExit.png" "screens/kde-5_fileExit.png" && sleep 1
+ * 	click_i "screens/gnome-6_discard.png" "screens/kde-6_discard.png" && sleep 1
+ * }
+ * \endcode
+ * <li>Use the \c click_i function to close down LibreOffice writer - Find the "File" menu, click "Exit", and then make sure to discard all changes.
+ * <br><br>
+ * \code
+ * start_libreoffice_writer
+ * close_libreoffice_writer
+ * \endcode
+ * <li>Actually run the functions given.
+ * <br><br>
+ * <li>Please note that this is a fairly trivial example. The full list of commands available in the wrapper is given in \ref wrapper_functions
+ * </ul>
+ *
+ * \subsection testing_test_wrapper Testing the Testing Wrapper
+ * <ul>
+ * <li>First things first, run through the testing wrapper to make sure that everything is O.K.
+ * <li>If you need to, some things you can do to tune the application test are as follows:
+ * 		<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.
+ * 			</ul>
+ * 		<li>Set the \c CENTER
+ * 			<ul>
+ * 			<li>By default, the wrapper will use the center of an image as opposed to the upper-left corner to click on. To change this behavior, set: \code CENTER="" \endcode
+ * 			<li>To set the behavior back to using center-based matching, set: \code CENTER="c" \endcode
+ * 			</ul>
+ * 		<li>Set the \c OUTFILE and \c ERRFILE
+ * 			<ul>
+ * 			<li>The application wrapper logs a whole lot of information about what it does to make debugging easy. However, to make sure that you're not overwhelmed by the output, the wrapper also directs the output to <tt>/dev/null</tt> by default.
+ * 			<li>To redirect the output of \c OUTFILE and \c ERRFILE, set them to any file you want. For example, the following code will create a temporary file for OUTFILE and ERRFILE, and notify you of what they are:
+ * \code
+ * OUTFILE=`mktemp`
+ * ERRFILE=`mktemp`
+ * echo "OUTFILE location: $OUTFILE"
+ * echo "ERRFILE location: $ERRFILE"
+ * \endcode
+ *			</ul>
+ *		</ul>
+ *	<li>A full list of commands provided by the wrapper is available at \ref wrapper_functions
+ *	</ul>
+ *
+ * \note These options are controlled using the testing script as demonstrated above. Any modifications to the following values should be done at the line: \code #Changing any wrapper parameters should go here \endcode
+ * </ul>
+ * \section wrapping_up Wrapping Up
+ * <ul>
+ * <li>At this point you should have all the information you need to write your own application tests. The libcvautomation library and reference programs were designed to be simple and powerful, but if you invest the time to learn them and some expert BASH scripting, you can do some very complex things. 
+ * 		<ul>
+ * 		<li>For example, integrating a <a href="http://testanything.org/wiki/index.php/Tap-functions">Test Anything Protocol</a> wrapper into your scripts as well.
+ * 		</ul>
+ * <li>If you have questions, comments, concerns, suggestions, or feedback in general, feel free to let me know at <a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>.
+ * </ul>
+ *
+ * \section wrapper_functions Appendix of Wrapper Functions
+ * \code click \endcode
+ * Click the mouse where it is currently located
+ * <br><br>
+ *
+ * \code click_xy <x-coordinate> <y-coordinate> \endcode
+ * Click the mouse on an absolute point on screen
+ * 	\note The actual process is to move the mouse to the given location, then click there.
+ * <br><br>
+ *
+ * \code clickr_xy <x-increment> <y-increment> \endcode
+ * Click the mouse on the screen relative to where the mouse is at
+ *  \note The actual process is to move the mouse the given distance, then click there.
+ *  \note Also, note that a positive \c x-increment moves the mouse to the right, and a positive \c y-increment moves the mouse down.
+ * <br><br>
+ *
+ * \code click_i <filename> \endcode
+ * Click the mouse on a screenshot from \c filename
+ * 	\note This is affected by the \c CENTER, \c TOLERANCE, and \c SEARCH_METHOD variables. See \ref testing_test_wrapper for more information on these.
+ * <br><br>
+ *
+ * \code image_location <filename> \endcode
+ * Get the location of an image on screen
+ * 	\note This is affected by the \c CENTER, \c TOLERANCE, and \c SEARCH_METHOD variables. See \ref testing_test_wrapper for more information on these.
+ * <br><br>
+ *
+ * \code hover_xy <x-coordinate> <y-increment> \endcode
+ * Move the mouse to a location on screen using absolute positioning
+ * <br><br>
+ *
+ * \code hoverr_xy <x-increment> <y-increment> \endcode
+ * Move the mouse to a location on screen using relative positioning
+ *  \note Note that a positive \c x-increment moves the mouse to the right, and a positive \c y-increment moves the mouse down.
+ * <br><br>
+ *
+ * \code hover_i <filename> \endcode
+ * Move the mouse to a location on screen based on screenshot
+ * 	\note This is affected by the \c CENTER, \c TOLERANCE, and \c SEARCH_METHOD variables. See \ref testing_test_wrapper for more information on these.
+ * <br><br>
+ *
+ * \code key_str "<string>" \endcode
+ * Enter a string of characters on the keyboard rather than a single character at a time.
+ *  \warning This function <b>does not</b> accept key strings like "Space" as \c key_down, \c key_up, and \c key_click do. If you pass in "Space", that is exactly what will be typed.
+ * <br><br>
+ *
+ * \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.
+ * <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.
+ * <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.
+ * <br><br>
+ *
+ * \code run_process "<process-name>" \endcode
+ * Start a process on the system, background it, and return the PID of the created process.
+ * <br><br>
+ *
+ * \code is_running "<process-name>" \endcode
+ * \code is_running "<process-id>" \endcode
+ * Check if a program name or PID is currently running
+ */
+
 /** \struct cvautomationList
 * \brief Implements a structure to build an array for methods like matchSubImage_a()
 * \details This structure is a simple way to wrap up all needed information for matching sub images in one location.
--- a/include/opencv2/libcvautomation/libcvautomation.h
+++ b/include/opencv2/libcvautomation/libcvautomation.h
@ -83,6 +83,23 @@ typedef struct {
 * \section questions Questions? Comments? Concerns?
 * Please send any feedback to <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>. Pull requests can be submitted to <a href="https://github.com/DjBushido/cvautomation">my github repository</a>.*/

+/** \page libcvautomation Libcvautomation
+ * \author Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>
+ * \date 7/11/2012
+ * \section intro Introduction
+ * Welcome to Libcvautomation!
+ * Libcvautomation is a GUI automation and testing tool based on image recognition and response. This program was designed as a direct replacement for <a href="http://sikuli.org">Sikuli</a> and <a href="https://wiki.ubuntu.com/Xpresser">Xpresser</a>. I was having incredible difficulty getting either of these solutions to work - Sikuli would crash whenever I tried to take a screenshot, and Xpresser was both too new for our RHEL 5 systems, but also died, or didn't work, or something else. I really liked the way each of these programs approached GUI automation, but they simply didn't work. Additionally, I wanted to create a simple solution - it does what you want it to, and that's it.
+ * \section how_it_works How Libcvautomation Works
+ * Libcvautomation represents two software products coming together - <a href="http://opencv.willowgarage.com/wiki/">OpenCV</a> and the <a href="http://www.x.org/docs/Xext/xtest.pdf">XTest extension</a> to the X11 server. OpenCV is used for image recognition, and XTest is used to actually drive the X server. You can dig into \ref libcvautomation-xtest.h to get an idea of what all this library is capable of. <br>
+ * Basically what happens is that for whenever you need to do image recognition, OpenCV is used to find the images, and XTest is used to generate any events needed. Libcvautomation is mostly a wrapper to integrate both of these products, but also adds some functions like matchSubImage_X11() that allow you to match an image against the X11 root window in place. This means no more <tt>'xwd | convert "<out_name>"'</tt>.
+ * \section using Using Libcvautomation
+ * So how does one go about using libcvautomation? <br>
+ * I'm so glad you asked! I've provided a few reference programs - \c cva-match and \c cva-input - that can be used to demonstrate most of libcvautomation's capabilities. I've even provided a BASH wrapper to make it incredibly easy to use BASH with libcvautomation as well (requires that cva-match and cva-input are installed). Python bindings are on their way too. <br>
+ * Finally, if you want to know how to write your own application tests, please see \ref writing_app_tests for more information on that.
+ * \section questions Questions? Comments? Concerns?
+ * Please send any feedback to <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>. Pull requests can be submitted to <a href="https://github.com/DjBushido/cvautomation">my github repository</a>.
+ */
+
 /** \page writing_app_tests Writing Application Tests
 * \author Bradlee Speice <<a href="mailto:bspeice@uncc.edu">bspeice@uncc.edu</a>>
 * \date 7/11/2012