From fcc90be5824de43f570f90de0b0cf950e2b39bff Mon Sep 17 00:00:00 2001
From: Anatol Belski <ab@php.net>
Date: Fri, 18 Apr 2014 19:31:48 +0000
Subject: [PATCH] documented hrtime classes methods

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333375 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../getelapsedticks.xml                       |  8 +++----
 .../getfrequency.xml                          |  9 ++++----
 .../getlastelapsedticks.xml                   |  8 +++----
 .../hrtime-performancecounter/isrunning.xml   |  8 +++----
 .../hrtime-performancecounter/start.xml       | 11 +++++----
 .../hrtime/hrtime-performancecounter/stop.xml | 10 ++++----
 .../hrtime-stopwatch/getelapsedtime.xml       | 22 +++++++++++++-----
 .../hrtime-stopwatch/getlastelapsedtime.xml   | 23 +++++++++++++------
 8 files changed, 56 insertions(+), 43 deletions(-)

diff --git a/reference/hrtime/hrtime-performancecounter/getelapsedticks.xml b/reference/hrtime/hrtime-performancecounter/getelapsedticks.xml
index 1b9ca37429..d91dbbde0d 100644
--- a/reference/hrtime/hrtime-performancecounter/getelapsedticks.xml
+++ b/reference/hrtime/hrtime-performancecounter/getelapsedticks.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="hrtime-performancecounter.getelapsedticks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\PerformanceCounter::getElapsedTicks</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Get elapsed ticks for all intervals.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,9 @@
    <void />
   </methodsynopsis>
   <para>
-
+Get elapsed ticks for all the previously closed intervals.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns &integer; indicating elapsed ticks. 
   </para>
  </refsect1>
 
diff --git a/reference/hrtime/hrtime-performancecounter/getfrequency.xml b/reference/hrtime/hrtime-performancecounter/getfrequency.xml
index 27e7c6a7d2..b949e957ec 100644
--- a/reference/hrtime/hrtime-performancecounter/getfrequency.xml
+++ b/reference/hrtime/hrtime-performancecounter/getfrequency.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="hrtime-performancecounter.getfrequency" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\PerformanceCounter::getFrequency</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Timer frequency in ticks per second</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,10 @@
    <void />
   </methodsynopsis>
   <para>
-
+Returns the timer frequency in ticks per second. This value is constant after
+the system start on almost any operating system.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +28,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns &integer; indicating the timer frequency. 
   </para>
  </refsect1>
 
diff --git a/reference/hrtime/hrtime-performancecounter/getlastelapsedticks.xml b/reference/hrtime/hrtime-performancecounter/getlastelapsedticks.xml
index 8d0d51b8db..59521deeab 100644
--- a/reference/hrtime/hrtime-performancecounter/getlastelapsedticks.xml
+++ b/reference/hrtime/hrtime-performancecounter/getlastelapsedticks.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="hrtime-performancecounter.getlastelapsedticks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\PerformanceCounter::getLastElapsedTicks</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Get elapsed ticks for the last interval.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,9 @@
    <void />
   </methodsynopsis>
   <para>
-
+Get elapsed ticks for the previously closed interval.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns &integer; indicating elapsed ticks. 
   </para>
  </refsect1>
 
diff --git a/reference/hrtime/hrtime-performancecounter/isrunning.xml b/reference/hrtime/hrtime-performancecounter/isrunning.xml
index bb6d10b6c9..bbe79dcb0b 100644
--- a/reference/hrtime/hrtime-performancecounter/isrunning.xml
+++ b/reference/hrtime/hrtime-performancecounter/isrunning.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="hrtime-performancecounter.isrunning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\PerformanceCounter::isRunning</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Whether the measurement is running.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,9 @@
    <void />
   </methodsynopsis>
   <para>
-
+Reveals whether the measurement was started.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns &boolean; indicating whetehr the measurement is running. 
   </para>
  </refsect1>
 
diff --git a/reference/hrtime/hrtime-performancecounter/start.xml b/reference/hrtime/hrtime-performancecounter/start.xml
index 31e8228529..4a593724c8 100644
--- a/reference/hrtime/hrtime-performancecounter/start.xml
+++ b/reference/hrtime/hrtime-performancecounter/start.xml
@@ -4,21 +4,22 @@
 <refentry xml:id="hrtime-performancecounter.start" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\PerformanceCounter::start</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Start time measurement</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>ReturnType</type><methodname>HRTime\PerformanceCounter::start</methodname>
+   <modifier>public</modifier> <type>void</type><methodname>HRTime\PerformanceCounter::start</methodname>
    <void />
   </methodsynopsis>
   <para>
+Starts the time measurement. It has no effect if the measurement was already
+started. The measurement will be continued if it was previously stopped.
+
 
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +30,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns void. 
   </para>
  </refsect1>
 
diff --git a/reference/hrtime/hrtime-performancecounter/stop.xml b/reference/hrtime/hrtime-performancecounter/stop.xml
index 2184323953..28eae34426 100644
--- a/reference/hrtime/hrtime-performancecounter/stop.xml
+++ b/reference/hrtime/hrtime-performancecounter/stop.xml
@@ -4,20 +4,20 @@
 <refentry xml:id="hrtime-performancecounter.stop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\PerformanceCounter::stop</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Stop time measurement</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>ReturnType</type><methodname>HRTime\PerformanceCounter::stop</methodname>
+   <modifier>public</modifier> <type>void</type><methodname>HRTime\PerformanceCounter::stop</methodname>
    <void />
   </methodsynopsis>
   <para>
 
-  </para>
+Stop the time measurement for the previously started interval.
 
-  &warn.undocumented.func;
+  </para>
 
  </refsect1>
 
@@ -29,7 +29,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns void. 
   </para>
  </refsect1>
 
diff --git a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml
index a0d4265edd..acaa9461b8 100644
--- a/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml
+++ b/reference/hrtime/hrtime-stopwatch/getelapsedtime.xml
@@ -4,31 +4,41 @@
 <refentry xml:id="hrtime-stopwatch.getelapsedtime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\StopWatch::getElapsedTime</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Get elapsed time for all intervals.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>ReturnType</type><methodname>HRTime\StopWatch::getElapsedTime</methodname>
-   <void />
+   <modifier>public</modifier> <type>float</type><methodname>HRTime\StopWatch::getElapsedTime</methodname>
+   <methodparam choice="opt"><type>integer</type><parameter>unit</parameter></methodparam>
   </methodsynopsis>
   <para>
 
+Get elapsed time for all the previously closed intervals. 
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+   <variablelist>
+    <varlistentry>
+     <term><parameter>unit</parameter></term>
+      <listitem>
+       <para>
+         Time unit represented by a HRTime\Unit constant. Default is
+         HRTime\Unit::SECOND.
+       </para>
+      </listitem>
+    </varlistentry>
+   </variablelist>
  </refsect1>
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
+  Returns &float; indicating elapsed time. 
    
   </para>
  </refsect1>
diff --git a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml
index 99d6d225d8..e09b018aa6 100644
--- a/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml
+++ b/reference/hrtime/hrtime-stopwatch/getlastelapsedtime.xml
@@ -4,32 +4,41 @@
 <refentry xml:id="hrtime-stopwatch.getlastelapsedtime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>HRTime\StopWatch::getLastElapsedTime</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Get elapsed time for the last interval.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>ReturnType</type><methodname>HRTime\StopWatch::getLastElapsedTime</methodname>
-   <void />
+   <modifier>public</modifier> <type>float</type><methodname>HRTime\StopWatch::getLastElapsedTime</methodname>
+   <methodparam choice="opt"><type>integer</type><parameter>unit</parameter></methodparam>
   </methodsynopsis>
   <para>
 
+Get elapsed time for the previously closed interval. 
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+   <variablelist>
+    <varlistentry>
+     <term><parameter>unit</parameter></term>
+      <listitem>
+       <para>
+         Time unit represented by a HRTime\Unit constant. Default is
+         HRTime\Unit::SECOND.
+       </para>
+      </listitem>
+    </varlistentry>
+   </variablelist>
  </refsect1>
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+  Returns &float; indicating elapsed time.  
   </para>
  </refsect1>