Mercurial > octave
diff libinterp/corefcn/pr-output.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 | 19755f4fc851 |
children | 00cf2847355d |
line wrap: on
line diff
--- a/libinterp/corefcn/pr-output.cc Thu May 07 17:16:36 2015 -0400 +++ b/libinterp/corefcn/pr-output.cc Sat May 09 17:19:30 2015 -0700 @@ -3407,7 +3407,8 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} rats (@var{x}, @var{len})\n\ Convert @var{x} into a rational approximation represented as a string.\n\ -You can convert the string back into a matrix as follows:\n\ +\n\ +The string can be converted back into a matrix as follows:\n\ \n\ @example\n\ @group\n\ @@ -3489,7 +3490,9 @@ DEFUN (disp, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} disp (@var{x})\n\ -Display the value of @var{x}. For example:\n\ +Display the value of @var{x}.\n\ +\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -3503,8 +3506,8 @@ @noindent\n\ Note that the output from @code{disp} always ends with a newline.\n\ \n\ -If an output value is requested, @code{disp} prints nothing and\n\ -returns the formatted output in a string.\n\ +If an output value is requested, @code{disp} prints nothing and returns the\n\ +formatted output in a string.\n\ @seealso{fdisp}\n\ @end deftypefn") { @@ -3534,7 +3537,9 @@ DEFUN (fdisp, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} fdisp (@var{fid}, @var{x})\n\ -Display the value of @var{x} on the stream @var{fid}. For example:\n\ +Display the value of @var{x} on the stream @var{fid}.\n\ +\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -3890,10 +3895,12 @@ @deftypefn {Command} {} format\n\ @deftypefnx {Command} {} format options\n\ Reset or specify the format of the output produced by @code{disp} and\n\ -Octave's normal echoing mechanism. This command only affects the display\n\ -of numbers but not how they are stored or computed. To change the internal\n\ -representation from the default double use one of the conversion functions\n\ -such as @code{single}, @code{uint8}, @code{int64}, etc.\n\ +Octave's normal echoing mechanism.\n\ +\n\ +This command only affects the display of numbers but not how they are stored\n\ +or computed. To change the internal representation from the default double\n\ +use one of the conversion functions such as @code{single}, @code{uint8},\n\ +@code{int64}, etc.\n\ \n\ By default, Octave displays 5 significant digits in a human readable form\n\ (option @samp{short} paired with @samp{loose} format for matrices).\n\ @@ -4053,7 +4060,7 @@ Insert blank lines above and below column number labels and between matrices\n\ to produce a more readable output with less data per page. (default).\n\ @end table\n\ -@seealso{fixed_point_format, output_max_field_width, output_precision, split_long_rows, rats}\n\ +@seealso{fixed_point_format, output_max_field_width, output_precision, split_long_rows, print_empty_dimensions, rats}\n\ @end deftypefn") { octave_value_list retval; @@ -4122,7 +4129,7 @@ @code{fixed_point_format}.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{format, output_max_field_width, output_precision}\n\ @end deftypefn") @@ -4135,9 +4142,10 @@ @deftypefn {Built-in Function} {@var{val} =} print_empty_dimensions ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} print_empty_dimensions (@var{new_val})\n\ @deftypefnx {Built-in Function} {} print_empty_dimensions (@var{new_val}, \"local\")\n\ -Query or set the internal variable that controls whether the\n\ -dimensions of empty matrices are printed along with the empty matrix\n\ -symbol, @samp{[]}. For example, the expression\n\ +Query or set the internal variable that controls whether the dimensions of\n\ +empty matrices are printed along with the empty matrix symbol, @samp{[]}.\n\ +\n\ +For example, the expression\n\ \n\ @example\n\ zeros (3, 0)\n\ @@ -4151,7 +4159,7 @@ @end example\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{format}\n\ @end deftypefn") @@ -4165,11 +4173,12 @@ @deftypefnx {Built-in Function} {@var{old_val} =} split_long_rows (@var{new_val})\n\ @deftypefnx {Built-in Function} {} split_long_rows (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether rows of a matrix\n\ -may be split when displayed to a terminal window. If the rows are split,\n\ -Octave will display the matrix in a series of smaller pieces, each of\n\ -which can fit within the limits of your terminal width and each set of\n\ -rows is labeled so that you can easily see which columns are currently\n\ -being displayed. For example:\n\ +may be split when displayed to a terminal window.\n\ +\n\ +If the rows are split, Octave will display the matrix in a series of smaller\n\ +pieces, each of which can fit within the limits of your terminal width and\n\ +each set of rows is labeled so that you can easily see which columns are\n\ +currently being displayed. For example:\n\ \n\ @example\n\ @group\n\ @@ -4189,7 +4198,7 @@ @end example\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{format}\n\ @end deftypefn") @@ -4206,7 +4215,7 @@ of a numeric output field.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{format, fixed_point_format, output_precision}\n\ @end deftypefn") @@ -4224,7 +4233,7 @@ significant figures to display for numeric output.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{format, fixed_point_format, output_max_field_width}\n\ @end deftypefn")