svn: /phpdoc/en/trunk/reference/datetime/functions/ microtime.xml
| From: | Adam Harvey | Date: | Tue, 08 Feb 2011 10:27:42 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/datetime/functions/ microtime.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7718@lists.php.net to get a copy of this message | ||
aharvey Tue, 08 Feb 2011 10:27:42 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=308125
Log:
Fix doc bug #53954 (no returing value description for microtime()).
Bug: http://bugs.php.net/53954 (Assigned) no returing value
description for microtime()
Changed paths:
U phpdoc/en/trunk/reference/datetime/functions/microtime.xml
Modified: phpdoc/en/trunk/reference/datetime/functions/microtime.xml
===================================================================
--- phpdoc/en/trunk/reference/datetime/functions/microtime.xml 2011-02-08 08:40:39 UTC (rev 308124)
+++ phpdoc/en/trunk/reference/datetime/functions/microtime.xml 2011-02-08 10:27:42 UTC (rev 308125)
@@ -27,22 +27,33 @@
<term><parameter>get_as_float</parameter></term>
<listitem>
<para>
- When called without the optional argument, this function returns the string
- "msec sec" where sec is the current time measured in the number of
- seconds since the Unix Epoch (0:00:00 January 1, 1970 GMT), and
- msec is the microseconds part.
- Both portions of the string are returned in units of seconds.
+ If used and set to &true;, <function>microtime</function> will return a
+ <type>float</type> instead of a <type>string</type>, as described in
+ the return values section below.
</para>
- <para>
- If the optional <parameter>get_as_float</parameter> is set to
- &true; then a <type>float</type> (in seconds) is returned.
- </para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ By default, <function>microtime</function> returns a <type>string</type>
in
+ the form "msec sec", where <literal>sec</literal> is the current time
+ measured in the number of seconds since the Unix epoch (0:00:00 January 1,
+ 1970 GMT), and <literal>msec</literal> is the number of microseconds that
+ have elapsed since <literal>sec</literal> expressed in seconds.
+ </para>
+ <para>
+ If <parameter>get_as_float</parameter> is set to &true;, then
+ <function>microtime</function> returns a <type>float</type>, which
+ represents the current time in seconds since the Unix epoch accurate to the
+ nearest microsecond.
+ </para>
+ </refsect1>
+
<refsect1 role="changelog">
&reftitle.changelog;
<para>