view docs/ccguide/sleep.refentry @ 2437:d26e96c40194

rfm changes
author aaronwolfe
date Wed, 24 Feb 2010 00:37:08 +0000
parents 57b5e715a417
children
line wrap: on
line source

<refentry id="sleep">
<refnamediv>
<refname>Sleep</refname>
<refpurpose>stop execution for a time</refpurpose>
</refnamediv>

<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
  <funcdef><function>sleep</function></funcdef>
  <paramdef>int <parameter>seconds</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>

<refsect1><title>Description</title>
<para>
The current task is stopped for the specified time.
</para>
<para>
If "seconds" is zero, the task will sleep for one tick.
</para>
</refsect1>
</refentry>