Mercurial > octave
diff libinterp/corefcn/toplev.cc @ 20172: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 | 1c9ed5b4c73d |
children | 9502e0142c19 |
line wrap: on
line diff
--- a/libinterp/corefcn/toplev.cc Thu May 07 17:16:36 2015 -0400 +++ b/libinterp/corefcn/toplev.cc Sat May 09 17:19:30 2015 -0700 @@ -958,15 +958,16 @@ @deftypefnx {Built-in Function} {} system (\"@var{string}\", @var{return_output}, @var{type})\n\ @deftypefnx {Built-in Function} {[@var{status}, @var{output}] =} system (@dots{})\n\ Execute a shell command specified by @var{string}.\n\ -If the optional argument @var{type} is @qcode{\"async\"}, the process\n\ -is started in the background and the process ID of the child process\n\ -is returned immediately. Otherwise, the child process is started and\n\ -Octave waits until it exits. If the @var{type} argument is omitted, it\n\ -defaults to the value @qcode{\"sync\"}.\n\ +\n\ +If the optional argument @var{type} is @qcode{\"async\"}, the process is\n\ +started in the background and the process ID of the child process is\n\ +returned immediately. Otherwise, the child process is started and Octave\n\ +waits until it exits. If the @var{type} argument is omitted, it defaults to\n\ +the value @qcode{\"sync\"}.\n\ \n\ If @var{system} is called with one or more output arguments, or if the\n\ optional argument @var{return_output} is true and the subprocess is started\n\ -synchronously, then the output from the command is returned as a variable. \n\ +synchronously, then the output from the command is returned as a variable.\n\ Otherwise, if the subprocess is executed synchronously, its output is sent\n\ to the standard output. To send the output of a command executed with\n\ @code{system} through the pager, use a command like\n\ @@ -1188,11 +1189,11 @@ @noindent\n\ will print the message @qcode{\"Bye bye\"} when Octave exits.\n\ \n\ -The additional argument @var{flag} will register or unregister\n\ -@var{fcn} from the list of functions to be called when Octave\n\ -exits. If @var{flag} is true, the function is registered, and if\n\ -@var{flag} is false, it is unregistered. For example,\n\ -after registering the function @code{last_words} above,\n\ +The additional argument @var{flag} will register or unregister @var{fcn}\n\ +from the list of functions to be called when Octave exits. If @var{flag} is\n\ +true, the function is registered, and if @var{flag} is false, it is\n\ +unregistered. For example, after registering the function @code{last_words}\n\ +above,\n\ \n\ @example\n\ atexit (\"last_words\", false);\n\ @@ -1203,9 +1204,8 @@ @code{last_words} when it exits.\n\ \n\ Note that @code{atexit} only removes the first occurrence of a function\n\ -from the list, so if a function was placed in the list multiple\n\ -times with @code{atexit}, it must also be removed from the list\n\ -multiple times.\n\ +from the list, so if a function was placed in the list multiple times with\n\ +@code{atexit}, it must also be removed from the list multiple times.\n\ @seealso{quit}\n\ @end deftypefn") {