comparison scripts/time/ctime.m @ 20162:2645f9ef8c88 stable

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
20160:03b9d17a2d95 20162:2645f9ef8c88
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} ctime (@var{t}) 20 ## @deftypefn {Function File} {} ctime (@var{t})
21 ## Convert a value returned from @code{time} (or any other non-negative 21 ## Convert a value returned from @code{time} (or any other non-negative
22 ## integer), to the local time and return a string of the same form as 22 ## integer), to the local time and return a string of the same form as
23 ## @code{asctime}. The function @code{ctime (time)} is equivalent to 23 ## @code{asctime}.
24 ##
25 ## The function @code{ctime (time)} is equivalent to
24 ## @code{asctime (localtime (time))}. For example: 26 ## @code{asctime (localtime (time))}. For example:
25 ## 27 ##
26 ## @example 28 ## @example
27 ## @group 29 ## @group
28 ## ctime (time ()) 30 ## ctime (time ())