From fcc90be5824de43f570f90de0b0cf950e2b39bff Mon Sep 17 00:00:00 2001 From: Anatol Belski 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 @@ HRTime\PerformanceCounter::getElapsedTicks - Description + Get elapsed ticks for all intervals. @@ -14,11 +14,9 @@ - +Get elapsed ticks for all the previously closed intervals. - &warn.undocumented.func; - @@ -29,7 +27,7 @@ &reftitle.returnvalues; - + Returns &integer; indicating elapsed ticks. 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 @@ HRTime\PerformanceCounter::getFrequency - Description + Timer frequency in ticks per second @@ -14,11 +14,10 @@ - +Returns the timer frequency in ticks per second. This value is constant after +the system start on almost any operating system. - &warn.undocumented.func; - @@ -29,7 +28,7 @@ &reftitle.returnvalues; - + Returns &integer; indicating the timer frequency. 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 @@ HRTime\PerformanceCounter::getLastElapsedTicks - Description + Get elapsed ticks for the last interval. @@ -14,11 +14,9 @@ - +Get elapsed ticks for the previously closed interval. - &warn.undocumented.func; - @@ -29,7 +27,7 @@ &reftitle.returnvalues; - + Returns &integer; indicating elapsed ticks. 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 @@ HRTime\PerformanceCounter::isRunning - Description + Whether the measurement is running. @@ -14,11 +14,9 @@ - +Reveals whether the measurement was started. - &warn.undocumented.func; - @@ -29,7 +27,7 @@ &reftitle.returnvalues; - + Returns &boolean; indicating whetehr the measurement is running. 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 @@ HRTime\PerformanceCounter::start - Description + Start time measurement &reftitle.description; - public ReturnTypeHRTime\PerformanceCounter::start + public voidHRTime\PerformanceCounter::start +Starts the time measurement. It has no effect if the measurement was already +started. The measurement will be continued if it was previously stopped. + - &warn.undocumented.func; - @@ -29,7 +30,7 @@ &reftitle.returnvalues; - + Returns void. 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 @@ HRTime\PerformanceCounter::stop - Description + Stop time measurement &reftitle.description; - public ReturnTypeHRTime\PerformanceCounter::stop + public voidHRTime\PerformanceCounter::stop - +Stop the time measurement for the previously started interval. - &warn.undocumented.func; + @@ -29,7 +29,7 @@ &reftitle.returnvalues; - + Returns void. 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 @@ HRTime\StopWatch::getElapsedTime - Description + Get elapsed time for all intervals. &reftitle.description; - public ReturnTypeHRTime\StopWatch::getElapsedTime - + public floatHRTime\StopWatch::getElapsedTime + integerunit +Get elapsed time for all the previously closed intervals. - &warn.undocumented.func; - &reftitle.parameters; - &no.function.parameters; + + + unit + + + Time unit represented by a HRTime\Unit constant. Default is + HRTime\Unit::SECOND. + + + + &reftitle.returnvalues; + Returns &float; indicating elapsed time. 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 @@ HRTime\StopWatch::getLastElapsedTime - Description + Get elapsed time for the last interval. &reftitle.description; - public ReturnTypeHRTime\StopWatch::getLastElapsedTime - + public floatHRTime\StopWatch::getLastElapsedTime + integerunit +Get elapsed time for the previously closed interval. - &warn.undocumented.func; - &reftitle.parameters; - &no.function.parameters; + + + unit + + + Time unit represented by a HRTime\Unit constant. Default is + HRTime\Unit::SECOND. + + + + &reftitle.returnvalues; - + Returns &float; indicating elapsed time.