Updated doc based on Bug # 598947

1 files changed, 141 insertions, 4 deletions

diff --git a/doc/pyldtp-doc.h b/doc/pyldtp-doc.h
index d884ced..1b91281 100644
--- a/doc/pyldtp-doc.h
+++ b/doc/pyldtp-doc.h
@@ -1126,6 +1126,9 @@
  * \n
  * \subpage waittillguinotexist - Suspend the operation till the
  * window quits
+ * \n
+ * \n
+ * \subpage windowuptime - Uptime of any given window
  *
  */
 
@@ -1251,8 +1254,75 @@
  * 
  * \section Description
  * 
- * If the given window name exist, this function returns 1. If window doesnot exist, then this function returns 0. Difference between \ref guiexist and waitguiexist is, waitguiexist waits for maximum 30 seconds. Still the window doesn't appear, then 0 is returned. We can set the environment variable 'GUI_TIMEOUT' to change the default waiting time. We can wait for component also and its an optional argument. The default value of guiTimeOut is None and it can be changed either by environment variable or by passing an integer argument > 0. This timeout will be for this specific window and it will not affect the global default time out settings. If you want to change the global default time out settings use guitimeout or objtimeout function appropriately.
- * 
+ * If the given window name exist, this function returns 1. If window
+ * doesnot exist, then this function returns 0. Difference between
+ * \ref guiexist and waitguiexist is, waitguiexist waits for maximum
+ * 30 seconds. Still the window doesn't appear, then 0 is returned. We
+ * can set the environment variable 'GUI_TIMEOUT' to change the
+ * default waiting time. We can wait for component also and its an
+ * optional argument. The default value of guiTimeOut is None and it
+ * can be changed either by environment variable or by passing an
+ * integer argument > 0. This timeout will be for this specific window
+ * and it will not affect the global default time out settings. If you
+ * want to change the global default time out settings use guitimeout
+ * or objtimeout function appropriately.
+ *
+ * \section section1 Different window types
+ *
+ *    1. Frame (frm)
+ *
+ *    2. Dialog (dlg)
+ *
+ *    3. Alert (dlg)
+ *
+ *    4. Font Chooser (dlg)
+ *
+ *    5. File Chooser (dlg)
+ *
+ *    6. Window (This type in general does not have any associated
+ *    title, so we need to represent them using index - dlg)
+ *
+ * \section section2 Glob Pattern support
+ *
+ * Window name can be clubbed with glob patterns (* or ?)
+ *
+ * \section section3 Different ways of representing window name
+ *
+ *    1. Window type and window title (Ex:
+ *    'frmUnsavedDocument1-gedit')
+ *
+ *    2. Window title (Ex: 'Unsaved Document 1 - gedit')
+ *
+ *    3. Window type, glob expression and partial window title (Ex:
+ *    'frm*-gedit')
+ *
+ *    4. Glob pattern and partial window title (Ex: '*-gedit')
+ *
+ *    5. Window type, partial window title and glob pattern (Ex:
+ *    'frmUnsavedDocument1*')
+ *
+ *    6. Window type, window title and index (If two windows of same
+ *    title exist at same time. Ex:
+ *       First window name 'dlgAppoinment', Second window name
+ *    'dlgAppoinment1')
+ *
+ *    7. Window type and index (only if window does not have any
+ *    accessible title, Ex: 'dlg0')
+ *
+ * \section section4 Window name formats
+ *
+ * If window label contains space or new line characters, they will be
+ * stripped.
+ *
+ * Example
+ *
+ *    1. 'Unsaved Document 1 – gedit', will be represented as
+ *    'UnsavedDocument1-gedit'
+ *
+ *    2. 'Unsaved Document 1
+ *
+ *        gedit', will be represented as 'UnsavedDocument1gedit'
+ *
  * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
  * 
  * \retval 1 on success, 0 otherwise
@@ -1274,8 +1344,75 @@
  * 
  * \section Description
  * 
- * If the given window name does not exist, this function returns 1. If window exist, then this function returns 0. Difference between \ref guiexist and waitguinotexist is, waitguinotexist waits for maximum 30 seconds. Still the window does not disappear, then 0 is returned. We can set the environment variable 'GUI_TIMEOUT' to change the default waiting time. We can wait for component also and its an optional argument. The default value of guiTimeOut is None and it can be changed either by environment variable or by passing an integer argument > 0. This timeout will be for this specific window and it will not affect the global default time out settings. If you want to change the global default time out settings use guitimeout or objtimeout function appropriately.
- * 
+ * If the given window name does not exist, this function returns
+ * 1. If window exist, then this function returns 0. Difference
+ * between \ref guiexist and waitguinotexist is, waitguinotexist waits
+ * for maximum 30 seconds. Still the window does not disappear, then 0
+ * is returned. We can set the environment variable 'GUI_TIMEOUT' to
+ * change the default waiting time. We can wait for component also and
+ * its an optional argument. The default value of guiTimeOut is None
+ * and it can be changed either by environment variable or by passing
+ * an integer argument > 0. This timeout will be for this specific
+ * window and it will not affect the global default time out
+ * settings. If you want to change the global default time out
+ * settings use guitimeout or objtimeout function appropriately.
+ *
+ * \section section1 Different window types
+ *
+ *    1. Frame (frm)
+ *
+ *    2. Dialog (dlg)
+ *
+ *    3. Alert (dlg)
+ *
+ *    4. Font Chooser (dlg)
+ *
+ *    5. File Chooser (dlg)
+ *
+ *    6. Window (This type in general does not have any associated
+ *    title, so we need to represent them using index - dlg)
+ *
+ * \section section2 Glob Pattern support
+ *
+ * Window name can be clubbed with glob patterns (* or ?)
+ *
+ * \section section3 Different ways of representing window name
+ *
+ *    1. Window type and window title (Ex:
+ *    'frmUnsavedDocument1-gedit')
+ *
+ *    2. Window title (Ex: 'Unsaved Document 1 - gedit')
+ *
+ *    3. Window type, glob expression and partial window title (Ex:
+ *    'frm*-gedit')
+ *
+ *    4. Glob pattern and partial window title (Ex: '*-gedit')
+ *
+ *    5. Window type, partial window title and glob pattern (Ex:
+ *    'frmUnsavedDocument1*')
+ *
+ *    6. Window type, window title and index (If two windows of same
+ *    title exist at same time. Ex:
+ *       First window name 'dlgAppoinment', Second window name
+ *    'dlgAppoinment1')
+ *
+ *    7. Window type and index (only if window does not have any
+ *    accessible title, Ex: 'dlg0')
+ *
+ * \section section4 Window name formats
+ *
+ * If window label contains space or new line characters, they will be
+ * stripped.
+ *
+ * Example
+ *
+ *    1. 'Unsaved Document 1 – gedit', will be represented as
+ *    'UnsavedDocument1-gedit'
+ *
+ *    2. 'Unsaved Document 1
+ *
+ *        gedit', will be represented as 'UnsavedDocument1gedit'
+ *
  * Refer: http://cgit.freedesktop.org/ldtp/ldtp/tree/src/client-handler.c
  * 
  * \retval 1 on success, 0 otherwise