Author: pekka.klarck
Date: Thu Apr 9 01:48:17 2009
New Revision: 1766
Modified:
trunk/doc/libraries/BuiltIn.html
Log:
regen
Modified: trunk/doc/libraries/BuiltIn.html
==============================================================================
--- trunk/doc/libraries/BuiltIn.html (original)
+++ trunk/doc/libraries/BuiltIn.html Thu Apr 9 01:48:17 2009
@@ -82,9 +82,9 @@
<p><b>Version:</b> trunk 20090408</p>
<h2 id="introduction">Introduction</h2>
-<p class='libdoc'>BuiltIn library provides a set of often needed generic
keywords.<br />
+<p class='libdoc'>An always available standard library with often needed
keywords.<br />
<br />
-These keywords are available automatically without importing any library.
They allow functionality for verifications (e.g. <a href="#Should Be Equal"
class="name">Should Be Equal</a>), conversions (e.g. <a href="#Convert To
Integer" class="name">Convert To Integer</a>) and for various other
purposes (e.g. <a href="#Sleep" class="name">Sleep</a>, <a href="#Run
Keyword If" class="name">Run Keyword If</a>).</p>
+<span class="name">BuiltIn</span> is Robot Framework's standard library
that provides a set of generic keywords needed often. It is imported
automatically and thus always available. The provided keywords can be
used, for example, for verifications (e.g. <a href="#Should Be Equal"
class="name">Should Be Equal</a>, <a href="#Should Contain"
class="name">Should Contain</a>), conversions (e.g. <a href="#Convert To
Integer" class="name">Convert To Integer</a>) and for various other
purposes (e.g. <a href="#Log" class="name">Log</a>, <a href="#Sleep"
class="name">Sleep</a>, <a href="#Run Keyword If" class="name">Run Keyword
If</a>, <a href="#Set Global Variable" class="name">Set Global
Variable</a>).</p>
<h2>Shortcuts</h2>
@@ -131,7 +131,7 @@
<a href="#Set Suite Variable" title="Makes a variable available everywhere
within the scope of the current
suite.">Set Suite Variable</a>
<a href="#Set Tags" title="Adds given `tags` for the current test or all
tests in a suite.">Set Tags</a>
<a href="#Set Test Variable" title="Makes a variable available everywhere
within the scope of the current test.">Set Test Variable</a>
-<a href="#Set Variable" title="Returns the given argument -- can be used
to set variables.">Set Variable</a>
+<a href="#Set Variable" title="Returns the given argument which can then
be assigned to a variable.">Set Variable</a>
<a href="#Set Variable If" title="Sets variable based on the given
condition.">Set Variable If</a>
<a href="#Should Be Empty" title="Verifies that the given item is
empty.">Should Be Empty</a>
<a href="#Should Be Equal" title="Fails if the given objects are
unequal.">Should Be Equal</a>
@@ -959,9 +959,11 @@
<tr>
<td class="kw"><a name="Set Variable"></a>Set Variable</td>
<td class="arg">*values</td>
- <td class="doc">Returns the given argument -- can be used to set
variables.<br />
+ <td class="doc">Returns the given argument which can then be assigned to
a variable.<br />
<br />
-Can also be used to convert a scalar variable containing list to a list
variable or to multiple scalar variables.<br />
+This keyword is mainly used for setting scalar variables. Additionally it
can be used for converting a scalar variable containing a list to a list
variable or to multiple scalar variables.<br />
+<br />
+Using this keyword with more (or less) than one value has been deprecated
in Robot Framework 2.1 and that usage will be removed in 2.2 version.<br />
<br />
Examples:<br />
<table border="1" class="doc">
@@ -991,9 +993,7 @@
</tr>
</table>
<br />
-Variables created with this keyword are available only in the scope where
they are created. See <a href="#Set Global Variable" class="name">Set
Global Variable</a>, <a href="#Set Test Variable" class="name">Set Test
Variable</a> and <a href="#Set Suite Variable" class="name">Set Suite
Variable</a> for information on how to set variables so that they are
available also in a larger scope.<br />
-<br />
-Using this keyword with more (or less) than one value has been deprecated
in Robot Framework 2.1 and that usage will be removed in 2.2.</td>
+Variables created with this keyword are available only in the scope where
they are created. See <a href="#Set Global Variable" class="name">Set
Global Variable</a>, <a href="#Set Test Variable" class="name">Set Test
Variable</a> and <a href="#Set Suite Variable" class="name">Set Suite
Variable</a> for information on how to set variables so that they are
available also in a larger scope.</td>
</tr>
<tr>
<td class="kw"><a name="Set Variable If"></a>Set Variable If</td>
@@ -1496,7 +1496,7 @@
<p class="footer">
Altogether 73 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-08 11:47:23.
+on 2009-04-09 11:48:06.
</p>
</body>
</html>
