[Kst] www/areas/extragear/apps/kst/kstscript/docs

[Andrew Walker]

SVN commit 820360 by arwalker:

update javaScript online documentation

 M  +7 -3      DataSource.html  
 M  +2 -13     DebugLog.html  
 M  +1 -1      File.html  
 M  +2 -2      Legend.html  


--- trunk/www/areas/extragear/apps/kst/kstscript/docs/DataSource.html #820359:820360
@@ -21,7 +21,7 @@
 <a class="link" href="#constructor_1">DataSource</a> ( url [, type] )<br>
 </ul>
 <span class="title">Methods:</span><ul>
-<a class="link" href="#method_isValidField">isValidField</a> (  )<br><a class="link" href="#method_fieldList">fieldList</a> (  )<br><a class="link" href="#method_reset">reset</a> (  )<br><a class="link" href="#method_matrixList">matrixList</a> (  )<br><a class="link" href="#method_samplesPerFrame">samplesPerFrame</a> ( field )<br><a class="link" href="#method_frameCount">frameCount</a> (  [field] )<br><a class="link" href="#method_setConfiguration">setConfiguration</a> ( setting, setting )<br><a class="link" href="#method_configuration">configuration</a> ( setting )<br>
+<a class="link" href="#method_isValidField">isValidField</a> ( field )<br><a class="link" href="#method_fieldList">fieldList</a> (  )<br><a class="link" href="#method_reset">reset</a> (  )<br><a class="link" href="#method_matrixList">matrixList</a> (  )<br><a class="link" href="#method_samplesPerFrame">samplesPerFrame</a> ( field )<br><a class="link" href="#method_frameCount">frameCount</a> (  [field] )<br><a class="link" href="#method_setConfiguration">setConfiguration</a> ( setting, setting )<br><a class="link" href="#method_configuration">configuration</a> ( setting )<br>
 </ul>
 <span class="title">Properties:</span><ul>
 <a class="link" href="#property_valid">valid</a><br><a class="link" href="#property_empty">empty</a><br><a class="link" href="#property_completeFieldList">completeFieldList</a><br><a class="link" href="#property_fileName">fileName</a><br><a class="link" href="#property_fileType">fileType</a><br><a class="link" href="#property_source">source</a><br><a class="link" href="#property_metaData">metaData</a><br>
@@ -42,8 +42,12 @@
     
     </p>
 </ul>
-<br><br><span class="subTitle"><a name="method_isValidField"></a><b>boolean isValidField (  )</b></span><br><ul>
-<div class="parameters"></div>
+<br><br><span class="subTitle"><a name="method_isValidField"></a><b>boolean isValidField ( string field )</b></span><br><ul>
+<div class="parameters">string <b>field</b> - 
+      A field name to check for.
+       
+      <br>
+</div>
 <p>
     Returns if the field is valid or not.
     
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/DebugLog.html #820359:820360
@@ -18,22 +18,11 @@
   </p>
 <br>
 </div>
-<br><span class="title">Constructors:</span><ul>
-<a class="link" href="#constructor_1">DebugLog</a> (  )<br>
-</ul>
-<span class="title">Properties:</span><ul>
+<br><span class="title">Properties:</span><ul>
 <a class="link" href="#property_length">length</a><br><a class="link" href="#property_text">text</a><br><a class="link" href="#property_lengthNotices">lengthNotices</a><br><a class="link" href="#property_textNotices">textNotices</a><br><a class="link" href="#property_lengthWarnings">lengthWarnings</a><br><a class="link" href="#property_textWarnings">textWarnings</a><br><a class="link" href="#property_lengthErrors">lengthErrors</a><br><a class="link" href="#property_textErrors">textErrors</a><br><a class="link" href="#property_lengthDebugs">lengthDebugs</a><br><a class="link" href="#property_textDebugs">textDebugs</a><br>
 </ul>
 <hr>
-<br><span class="subTitle"><a name="constructor_1"></a><b>DebugLog (  )</b></span><br><ul>
-<div class="parameters"></div>
-<p>
-    Create a new DebugLog object which is a reference to the
-                    Kst debug log.
-    
-    </p>
-</ul>
-<br><br><span class="subTitle"><a name="property_length"></a><b>number  length [Read-Only]</b></span><br><ul><p>
+<br><span class="subTitle"><a name="property_length"></a><b>number  length [Read-Only]</b></span><br><ul><p>
     The number of entries in the log.
     
     </p></ul>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/File.html #820359:820360
@@ -65,7 +65,7 @@
     The name of the file.
     
     </p></ul>
-<br><br><span class="subTitle"><a name="property_size"></a><b><a class="link" href="Size.html">Size</a>  size</b></span><br><ul><p>
+<br><br><span class="subTitle"><a name="property_size"></a><b>number  size</b></span><br><ul><p>
     The size of the file.
     
     </p></ul>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Legend.html #820359:820360
@@ -63,7 +63,7 @@
     Adds the curve to the legend.
        
     </p>
-      Throws: <b>GeneralError</b> - 
+      Throws: <b>TypeError</b> - 
       Throws this exception if the curve could not be found.
     
       <br>
@@ -78,7 +78,7 @@
     Removes the curve from the legend.
        
     </p>
-      Throws: <b>GeneralError</b> - 
+      Throws: <b>TypeError</b> - 
       Throws this exception if the curve could not be found.
     
       <br>