[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Tue Mar 17 18:19:23 CET 2009
SVN commit 940564 by arwalker:
update online javaScript documentation
M +9 -2 Axis.html
M +8 -4 Dir.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Axis.html #940563:940564
@@ -76,8 +76,15 @@
True if the opposite axis is suppressed. (Right X or top Y)
</p></ul>
-<br><br><span class="subTitle"><a name="property_offsetMode"></a><b>boolean offsetMode</b></span><br><ul><p>
- True if this axis is in base + offset mode.
+<br><br><span class="subTitle"><a name="property_offsetMode"></a><b>number offsetMode</b></span><br><ul><p>
+ The base + offset mode. Value must be one of:
+ <ul>
+ <li>0 - Automatic</li>
+ <li>1 - On</li>
+ <li>2 - Off</li>
+ </ul>
+ For backwards compatibility the value can also be set as a boolean, in which
+ case true corresponds to On and false corresponds to Automatic.
</p></ul>
<br><br><span class="subTitle"><a name="property_reversed"></a><b>boolean reversed</b></span><br><ul><p>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Dir.html #940563:940564
@@ -19,7 +19,7 @@
<a class="link" href="#constructor_1">Dir</a> ( name )<br>
</ul>
<span class="title">Methods:</span><ul>
-<a class="link" href="#method_fileList">fileList</a> ( nameFilters )<br><a class="link" href="#method_dirList">dirList</a> ( )<br>
+<a class="link" href="#method_fileList">fileList</a> ( nameFilters )<br><a class="link" href="#method_dirList">dirList</a> ( nameFilters )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_path">path</a><br>
@@ -47,10 +47,14 @@
</p>
</ul>
-<br><br><span class="subTitle"><a name="method_dirList"></a><b>StringArray dirList ( )</b></span><br><ul>
-<div class="parameters"></div>
+<br><br><span class="subTitle"><a name="method_dirList"></a><b>StringArray dirList ( string nameFilters )</b></span><br><ul>
+<div class="parameters">string <b>nameFilters</b> -
+ Specifies the name filters.
+
+ <br>
+</div>
<p>
- Returns a list of directories in the directory that match thr given name filters.
+ Returns a list of sub-directories in the directory that match the given name filters.
</p>
</ul>
More information about the Kst
mailing list