Updated documentation for v3.0.0

dtmilano · dtmilano · commit a490d5e993ab · 2013-07-17T23:30:19.000-04:00
diff --git a/AndroidViewClient/doc/class-tree.html b/AndroidViewClient/doc/class-tree.html
@@ -125,7 +125,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:01 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:56 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/help.html b/AndroidViewClient/doc/help.html
@@ -256,7 +256,7 @@ <h2> The Navigation Bar </h2>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:01 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:56 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/identifier-index.html b/AndroidViewClient/doc/identifier-index.html
@@ -675,7 +675,7 @@ <h1 class="epydoc">Identifier Index</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:01 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:56 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/module-tree.html b/AndroidViewClient/doc/module-tree.html
@@ -98,7 +98,7 @@ <h1 class="epydoc">Module Hierarchy</h1>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:01 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:56 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android-module.html b/AndroidViewClient/doc/src.com.dtmilano.android-module.html
@@ -144,7 +144,7 @@ <h1 class="epydoc">Package android</h1><p class="nomargin-top"><span class="code
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:01 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:56 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android-pysrc.html b/AndroidViewClient/doc/src.com.dtmilano.android-pysrc.html
@@ -102,7 +102,7 @@ <h1 class="epydoc">Source Code for <a href="src.com.dtmilano.android-module.html
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:03 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient-module.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient-module.html
@@ -87,7 +87,7 @@ <h1 class="epydoc">Module viewclient</h1><p class="nomargin-top"><span class="co
 
 <hr />
 <div class="fields">      <p><strong>Version:</strong>
-        2.3.25
+        3.0.0
       </p>
 </div><!-- ==================== CLASSES ==================== -->
 <a name="section-Classes"></a>
@@ -737,7 +737,7 @@ <h3 class="epydoc">SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED</h3>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:01 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:56 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient-pysrc.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient-pysrc.html
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.EditText-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.EditText-class.html
@@ -287,7 +287,7 @@ <h1 class="epydoc">Class EditText</h1><p class="nomargin-top"><span class="codel
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:02 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.Excerpt2Code-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.Excerpt2Code-class.html
@@ -204,7 +204,7 @@ <h1 class="epydoc">Class Excerpt2Code</h1><p class="nomargin-top"><span class="c
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:02 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.TextView-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.TextView-class.html
@@ -251,7 +251,7 @@ <h1 class="epydoc">Class TextView</h1><p class="nomargin-top"><span class="codel
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:02 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.UiAutomator2AndroidViewClient-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.UiAutomator2AndroidViewClient-class.html
@@ -206,7 +206,7 @@ <h1 class="epydoc">Class UiAutomator2AndroidViewClient</h1><p class="nomargin-to
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:02 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.View-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.View-class.html
@@ -1188,7 +1188,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">writeImageToFile</sp
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:02 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.ViewClient-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.ViewClient-class.html
@@ -217,8 +217,7 @@ <h1 class="heading">UiAutomator backend</h1>
       <table width="100%" cellpadding="0" cellspacing="0" border="0">
         <tr>
           <td><span class="summary-sig"><a href="src.com.dtmilano.android.viewclient.ViewClient-class.html#__splitAttrs" class="summary-sig-name" onclick="show_private();">__splitAttrs</a>(<span class="summary-sig-arg">self</span>,
-        <span class="summary-sig-arg">strArgs</span>,
-        <span class="summary-sig-arg">addViewToViewsById</span>=<span class="summary-sig-default">False</span>)</span><br />
+        <span class="summary-sig-arg">strArgs</span>)</span><br />
       Splits the <code>View</code> attributes in <code>strArgs</code> and 
       optionally adds the view id to the <code>viewsById</code> list.</td>
           <td align="right" valign="top">
@@ -1841,8 +1840,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">setViewsFromUiAutoma
   <table width="100%" cellpadding="0" cellspacing="0" border="0">
   <tr valign="top"><td>
   <h3 class="epydoc"><span class="sig"><span class="sig-name">__splitAttrs</span>(<span class="sig-arg">self</span>,
-        <span class="sig-arg">strArgs</span>,
-        <span class="sig-arg">addViewToViewsById</span>=<span class="sig-default">False</span>)</span>
+        <span class="sig-arg">strArgs</span>)</span>
   </h3>
   </td><td align="right" valign="top"
     ><span class="codelink"><a href="src.com.dtmilano.android.viewclient-pysrc.html#ViewClient.__splitAttrs">source&nbsp;code</a></span>&nbsp;
@@ -1856,17 +1854,14 @@ <h1 class="heading">Unique Ids</h1>
     the Id. This turns very difficult to use <a 
     href="src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewById"
     class="link">self.findViewById()</a>. To help in this situation this 
-    method assigns <b>unique Ids</b> if <code>addViewToViewsById</code> is 
-    <code>True</code>.</p>
+    method assigns <b>unique Ids</b>.</p>
     <p>The <b>unique Ids</b> are generated using the pattern 
     <code>id/no_id/&lt;number&gt;</code> with <code>&lt;number&gt;</code> 
     starting at 1.</p>
   <dl class="fields">
     <dt>Parameters:</dt>
     <dd><ul class="nomargin-top">
         <li><strong class="pname"><code>strArgs</code></strong> (str) - the string containing the raw list of attributes and values</li>
-        <li><strong class="pname"><code>addViewToViewsById</code></strong> (boolean) - whether to add the parsed list of attributes and values to the 
-          map <code>self.viewsById</code></li>
     </ul></dd>
     <dt>Returns:</dt>
         <dd>Returns the attributes map.</dd>
@@ -1892,7 +1887,11 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__parseTree</span>(<
   class="link">receivedLines</code>. The tree is created and the root node 
   assigned to <a 
   href="src.com.dtmilano.android.viewclient.ViewClient-class.html#root" 
-  class="link">self.root</a>.</p>
+  class="link">self.root</a>. This method also assigns <a 
+  href="src.com.dtmilano.android.viewclient.ViewClient-class.html#viewsById"
+  class="link">self.viewsById</a> values using <a 
+  href="src.com.dtmilano.android.viewclient.View-class.html#getUniqueId" 
+  class="link">View.getUniqueId</a> as the key.</p>
   <dl class="fields">
     <dt>Parameters:</dt>
     <dd><ul class="nomargin-top">
@@ -2380,7 +2379,7 @@ <h3 class="epydoc">views</h3>
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:02 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.ViewNotFoundException-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.ViewNotFoundException-class.html
@@ -261,7 +261,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<spa
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:03 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.Window-class.html b/AndroidViewClient/doc/src.com.dtmilano.android.viewclient.Window-class.html
@@ -221,7 +221,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<spa
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0.1 on Tue Jul  9 02:16:03 2013
+    Generated by Epydoc 3.0.1 on Wed Jul 17 23:29:57 2013
     </td>
     <td align="right" class="footer">
       <a target="mainFrame" href="http://epydoc.sourceforge.net"
