Mercurial > hg > octave-nkf
diff libinterp/corefcn/sysdep.cc @ 20382:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 17:19:30 -0700 |
parents | ab7582167810 |
children | aa36fb998a4d |
line wrap: on
line diff
--- a/libinterp/corefcn/sysdep.cc +++ b/libinterp/corefcn/sysdep.cc @@ -599,7 +599,9 @@ DEFUN (getenv, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} getenv (@var{var})\n\ -Return the value of the environment variable @var{var}. For example,\n\ +Return the value of the environment variable @var{var}.\n\ +\n\ +For example,\n\ \n\ @example\n\ getenv (\"PATH\")\n\ @@ -720,8 +722,11 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} kbhit ()\n\ @deftypefnx {Built-in Function} {} kbhit (1)\n\ -Read a single keystroke from the keyboard. If called with an\n\ -argument, don't wait for a keypress. For example,\n\ +Read a single keystroke from the keyboard.\n\ +\n\ +If called with an argument, don't wait for a keypress.\n\ +\n\ +For example,\n\ \n\ @example\n\ x = kbhit ();\n\ @@ -769,6 +774,7 @@ Suspend the execution of the program for @var{n} seconds.\n\ \n\ @var{n} is a positive real value and may be a fraction of a second.\n\ +\n\ If invoked without an input arguments then the program is suspended until a\n\ character is typed.\n\ \n\ @@ -876,9 +882,11 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} usleep (@var{microseconds})\n\ Suspend the execution of the program for the given number of\n\ -microseconds. On systems where it is not possible to sleep for periods\n\ -of time less than one second, @code{usleep} will pause the execution for\n\ -@code{round (@var{microseconds} / 1e6)} seconds.\n\ +microseconds.\n\ +\n\ +On systems where it is not possible to sleep for periods of time less than\n\ +one second, @code{usleep} will pause the execution for @code{round\n\ +(@var{microseconds} / 1e6)} seconds.\n\ @seealso{sleep, pause}\n\ @end deftypefn") { @@ -924,7 +932,9 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} isieee ()\n\ Return true if your computer @emph{claims} to conform to the IEEE standard\n\ -for floating point calculations. No actual tests are performed.\n\ +for floating point calculations.\n\ +\n\ +No actual tests are performed.\n\ @end deftypefn") { oct_mach_info::float_format flt_fmt = oct_mach_info::native_float_format (); @@ -940,7 +950,7 @@ DEFUN (native_float_format, , , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} native_float_format ()\n\ -Return the native floating point format as a string\n\ +Return the native floating point format as a string.\n\ @end deftypefn") { oct_mach_info::float_format flt_fmt = oct_mach_info::native_float_format (); @@ -955,13 +965,16 @@ DEFUN (tilde_expand, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} tilde_expand (@var{string})\n\ -Perform tilde expansion on @var{string}. If @var{string} begins with a\n\ -tilde character, (@samp{~}), all of the characters preceding the first\n\ -slash (or all characters, if there is no slash) are treated as a\n\ -possible user name, and the tilde and the following characters up to the\n\ -slash are replaced by the home directory of the named user. If the\n\ -tilde is followed immediately by a slash, the tilde is replaced by the\n\ -home directory of the user running Octave. For example:\n\ +Perform tilde expansion on @var{string}.\n\ +\n\ +If @var{string} begins with a tilde character, (@samp{~}), all of the\n\ +characters preceding the first slash (or all characters, if there is no\n\ +slash) are treated as a possible user name, and the tilde and the following\n\ +characters up to the slash are replaced by the home directory of the named\n\ +user. If the tilde is followed immediately by a slash, the tilde is\n\ +replaced by the home directory of the user running Octave.\n\ +\n\ +For example:\n\ \n\ @example\n\ @group\n\