Fixed documentation.

1 files changed, 44 insertions, 78 deletions

diff --git a/doc/pyldtp-doc.h b/doc/pyldtp-doc.h
index b3a6d4f..5340d6e 100644
--- a/doc/pyldtp-doc.h
+++ b/doc/pyldtp-doc.h
@@ -248,7 +248,11 @@
  * \n
  * \n
  * \subpage comboselect - Select an item from the combo box list or
- * menu item
+ * menu item based on name
+ * \n
+ * \n
+ * \subpage comboselectindex - Select an item from the combo box list or
+ * menu item based on index
  * \n
  * \n
  * \subpage hidelist - Hide the combo box drop down list
@@ -289,6 +293,9 @@
  *
  * \section GeneralAPI General python API's
  *
+ * \subpage bindtext - Bind text to the current application and current locale
+ * \n
+ * \n
  * \subpage generatekeyevent - Generate keyboard event on currently
  * focused window
  * \n
@@ -317,6 +324,12 @@
  * \subpage setcontext - Set the context information
  * \n
  * \n
+ * \subpage setlocale- Set locale to given locale
+ * \n
+ * \n
+ * \subpage stopscriptengine- Stop LDTP script engine
+ * \n
+ * \n
  * \subpage wait - Suspend the operation for specified duration
  *
  */
@@ -590,6 +603,9 @@
  * \subpage decrease - Decrease the slider
  * \n
  * \n
+ * \subpage getslidervalue - Get the slider value
+ * \n
+ * \n
  * \subpage increase - Increase the slider
  * \n
  * \n
@@ -681,6 +697,9 @@
  * \subpage doesrowexist - Checks whether the row with the given name exist
  * \n
  * \n
+ * \subpage doubleclick - Generate double click event on the component
+ * \n
+ * \n
  * \subpage doubleclickrow - Generate double click event on the row
  * with matches the given name
  * \n
@@ -896,6 +915,9 @@
  * \subpage doesrowexist - Checks whether the row with the given name exist
  * \n
  * \n
+ * \subpage doubleclick - Generate double click event on the component
+ * \n
+ * \n
  * \subpage doubleclickrow - Generate double click event on the row
  * which matches the given name
  * \n
@@ -1926,9 +1948,11 @@
  *
  * comboselect ('\<window name\>', '\<component name\>', '\<menu item name\>')
  *
+ * comboselect ('\<window name\>', '\<component name\>', '\<list item name\>')
+ *
  * \section Description
  *
- * Select a menu item or list item in a combo box
+ * Select a menu item or list item in a combo box based on name
  *
  * \retval 1 on success, LdtpExecutionError exception on failure
  *
@@ -1940,10 +1964,6 @@
  * 
  * comboselect ('SearchForFiles', 'cmbAvailableoptions', 'Contains the text')
  * 
- * or
- * 
- * comboselect ('SearchForFiles', 'cmbAvailableoptions', 'Containsthetext') 
- *
  * \author Poornima <pnayak@novell.com>
  */
 
@@ -2648,12 +2668,18 @@
  *
  * \section Example
  *
- * Push button: With respect to gedit open dialog, this function checks open button state enabled or not
+ * Push button: With respect to gedit Open dialog, this function checks open button state enabled or not
  * 
  * stateenabled ('dlgOpenFile', 'btnOpen')
  * 
- * \todo Radiobutton
+ * Radio button: With respect to gedit Print dialog, this function cheks the 'All' radio button state is enabled or not
+ *
+ * stateenabled ('Print', 'All')
+ * 
+ * Check box: With respect to gedit Print dialog, this function cheks the 'Reverse' check box state is enabled or not
  *
+ * stateenabled ('Print', 'Reverse')
+ * 
  * \author Nagappan A <nagappan@gmail.com>
  */
 
@@ -3245,22 +3271,6 @@
  * \author Bhargavi <kbhargavi_83@yahoo.co.in>
  */
 
-/** \page settablecell settablecell
- * \section Syntax
- *
- * \todo
- *
- * \section Description
- *
- * Refer: http://webcvs.freedesktop.org/ldtp/ldtp/src/table.c
- *
- * \section Example
- *
- * \todo
- *
- * \author Nagappan A <nagappan@gmail.com>
- */
-
 /** \page setcellvalue setcellvalue
  * \section Syntax
  *
@@ -3809,11 +3819,11 @@
 /** \page comboselectindex comboselectindex
  * \section Syntax
  *
- * \todo
+ * comboselectindex ('\<window name\>', '\<component name\>', \<index\>)
  *
  * \section Description
  *
- *
+ * In combo box, select the list value based on index.
  *
  * Refer: http://webcvs.freedesktop.org/ldtp/ldtp/src/combo-box.c
  *
@@ -3843,7 +3853,7 @@
  *
  * verifyvisiblebuttoncount ('*-gedit', 'tbar0', 12) # Gedit 2.12 default without any plugin
  *
- * \author J Premkumar <jpremkumar@novell.com>
+ * \author J Premkumar <prem.jothimani@gmail.com>
  */
 
 /** \page verifybuttoncount verifybuttoncount
@@ -3865,23 +3875,7 @@
  *
  * verifybuttoncount ('*-gedit', 'tbar0', 12) # Gedit 2.12 default without any plugin
  *
- * \author J Premkumar <jpremkumar@novell.com>
- */
-
-/** \page geteventcount geteventcount
- * \section Syntax
- *
- * \todo
- *
- * \section Description
- *
- *
- *
- * \section Example
- *
- * \todo
- *
- * \author 
+ * \author J Premkumar <prem.jothimani@gmail.com>
  */
 
 /** \page gettextvalue gettextvalue
@@ -4263,7 +4257,7 @@
 /** \page doubleclickrowindex doubleclickrowindex
  * \section Syntax
  *
- * doubleclickrowindex ('\<window name\>', '\<table name\>', <row index>)
+ * doubleclickrowindex ('\<window name\>', '\<table name\>', \<row index\>)
  *
  * \section Description
  *
@@ -4671,11 +4665,10 @@
  * 
  * this function is required mainly to check those menuitems which will not be present always. An example of this kind of a menuitem is the close tab menu item under menu file in firefox web browser. 
  *
- * \author prem.jothimani@gmail.com
+ * \author J Premkumar <prem.jothimani@gmail.com>
  */
 
-/**
- * \page startlog startlog
+/** \page startlog startlog
  * \section Syntax
  * 
  * startlog ('\<log file name\>', [0 or 1])
@@ -4712,8 +4705,7 @@
  * \author Nagappan <nagappan@gmail.com>
  */
 
-/**
- * \page stoplog stoplog
+/** \page stoplog stoplog
  * \section Syntax
  * 
  * stoplog ()
@@ -4733,8 +4725,7 @@
  */
 
 
-/**
- * \page startldtplog startldtplog
+/** \page startldtplog startldtplog
  * \section Syntax
  * 
  * startldtplog ('\<log file name\>', [0 or 1])
@@ -4771,8 +4762,7 @@
  * \author Nagappan <nagappan@gmail.com>
  */
 
-/**
- * \page stopldtplog stopldtplog
+/** \page stopldtplog stopldtplog
  * \section Syntax
  * 
  * stopldtplog ()
@@ -4924,30 +4914,6 @@
  * \author Subodh Soni <subodhsoni@gmail.com>
  */
 
-/** \page closeappwindow closeappwindow
- * \section Syntax
- *
- * closeappwindow ('\<Window title name\>')
- *
- * \section Description
- *
- * Close application window based on Window title. Returns 1 if success and 0 if unable to close the specified application window.
- *
- * Refer: http://webcvs.freedesktop.org/ldtp/ldtp/python/ldtputils.py
- *
- * \section Example
- *
- * from ldtputils import * 
- *
- * closeappwindow ('Bug Buddy')
- * 
- * \note Window title name should be case sensitive 
- *
- * \author Nagappan <nagappan@gmail.com>
- * \author Shankar Ganesh <shagan.glare@gmail.com>
- *
- */
-
 /** \page wait wait
  * \section Syntax
  *