Mercurial > octave-nkf

comparison scripts/time/clock.m @ 20197:2645f9ef8c88 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed specfun, special-matrix, testfun, and time script directories. * scripts/specfun/expint.m, scripts/specfun/isprime.m, scripts/specfun/legendre.m, scripts/specfun/primes.m, scripts/specfun/reallog.m, scripts/specfun/realsqrt.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m, scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m, scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m, scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m, scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m, scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m, scripts/testfun/rundemos.m, scripts/testfun/runtests.m, scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m, scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m, scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m, scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 17:00:11 -0700
parents 4197fc428c7d
children
comparison
equal deleted inserted replaced
20195:03b9d17a2d95 20197:2645f9ef8c88
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} clock () 20 ## @deftypefn {Function File} {} clock ()
21 ## Return the current local date and time as a date vector. The date vector 21 ## Return the current local date and time as a date vector.
22 ## contains the following fields: current year, month (1-12), day (1-31), 22 ##
23 ## hour (0-23), minute (0-59), and second (0-61). The seconds field has 23 ## The date vector contains the following fields: current year, month (1-12),
24 ## a fractional part after the decimal point for extended accuracy. 24 ## day (1-31), hour (0-23), minute (0-59), and second (0-61). The seconds
25 ## field has a fractional part after the decimal point for extended accuracy.
25 ## 26 ##
26 ## For example: 27 ## For example:
27 ## 28 ##
28 ## @example 29 ## @example
29 ## @group 30 ## @group
30 ## fix (clock ()) 31 ## fix (clock ())
31 ## @result{} [ 1993, 8, 20, 4, 56, 1 ] 32 ## @result{} [ 1993, 8, 20, 4, 56, 1 ]
32 ## @end group 33 ## @end group
33 ## @end example 34 ## @end example
34 ## 35 ##
35 ## The function clock is more accurate on systems that have the 36 ## @code{clock} is more accurate on systems that have the @code{gettimeofday}
36 ## @code{gettimeofday} function. 37 ## function.
37 ## @seealso{now, date, datevec} 38 ## @seealso{now, date, datevec}
38 ## @end deftypefn 39 ## @end deftypefn
39 40
40 ## Author: jwe 41 ## Author: jwe
41 42