Mercurial > octave

comparison libinterp/corefcn/pr-output.cc @ 20853:1142cf6abc0d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2015 Code Sprint: remove class of function from docstring for all C++ files.
author Rik <rik@octave.org>
date Sat, 12 Dec 2015 07:40:03 -0800
parents 35241c4b696c
children 9aad16a799c9
comparison
equal deleted inserted replaced
20852:516bb87ea72e 20853:1142cf6abc0d
3403 panic_impossible (); 3403 panic_impossible ();
3404 } 3404 }
3405 3405
3406 DEFUN (rats, args, nargout, 3406 DEFUN (rats, args, nargout,
3407 "-*- texinfo -*-\n\ 3407 "-*- texinfo -*-\n\
3408 @deftypefn {Built-in Function} {} rats (@var{x}, @var{len})\n\ 3408 @deftypefn {} {} rats (@var{x}, @var{len})\n\
3409 Convert @var{x} into a rational approximation represented as a string.\n\ 3409 Convert @var{x} into a rational approximation represented as a string.\n\
3410 \n\ 3410 \n\
3411 The string can be converted back into a matrix as follows:\n\ 3411 The string can be converted back into a matrix as follows:\n\
3412 \n\ 3412 \n\
3413 @example\n\ 3413 @example\n\
3482 return retval; 3482 return retval;
3483 } 3483 }
3484 3484
3485 DEFUN (disp, args, nargout, 3485 DEFUN (disp, args, nargout,
3486 "-*- texinfo -*-\n\ 3486 "-*- texinfo -*-\n\
3487 @deftypefn {Built-in Function} {} disp (@var{x})\n\ 3487 @deftypefn {} {} disp (@var{x})\n\
3488 Display the value of @var{x}.\n\ 3488 Display the value of @var{x}.\n\
3489 \n\ 3489 \n\
3490 For example:\n\ 3490 For example:\n\
3491 \n\ 3491 \n\
3492 @example\n\ 3492 @example\n\
3525 return retval; 3525 return retval;
3526 } 3526 }
3527 3527
3528 DEFUN (fdisp, args, , 3528 DEFUN (fdisp, args, ,
3529 "-*- texinfo -*-\n\ 3529 "-*- texinfo -*-\n\
3530 @deftypefn {Built-in Function} {} fdisp (@var{fid}, @var{x})\n\ 3530 @deftypefn {} {} fdisp (@var{fid}, @var{x})\n\
3531 Display the value of @var{x} on the stream @var{fid}.\n\ 3531 Display the value of @var{x} on the stream @var{fid}.\n\
3532 \n\ 3532 \n\
3533 For example:\n\ 3533 For example:\n\
3534 \n\ 3534 \n\
3535 @example\n\ 3535 @example\n\
3860 } 3860 }
3861 3861
3862 3862
3863 DEFUN (format, args, , 3863 DEFUN (format, args, ,
3864 "-*- texinfo -*-\n\ 3864 "-*- texinfo -*-\n\
3865 @deftypefn {Command} {} format\n\ 3865 @deftypefn {} {} format\n\
3866 @deftypefnx {Command} {} format options\n\ 3866 @deftypefnx {} {} format options\n\
3867 Reset or specify the format of the output produced by @code{disp} and\n\ 3867 Reset or specify the format of the output produced by @code{disp} and\n\
3868 Octave's normal echoing mechanism.\n\ 3868 Octave's normal echoing mechanism.\n\
3869 \n\ 3869 \n\
3870 This command only affects the display of numbers but not how they are stored\n\ 3870 This command only affects the display of numbers but not how they are stored\n\
3871 or computed. To change the internal representation from the default double\n\ 3871 or computed. To change the internal representation from the default double\n\
4044 return retval; 4044 return retval;
4045 } 4045 }
4046 4046
4047 DEFUN (__compactformat__, args, nargout, 4047 DEFUN (__compactformat__, args, nargout,
4048 "-*- texinfo -*-\n\ 4048 "-*- texinfo -*-\n\
4049 @deftypefn {Built-in Function} {@var{val} =} __compactformat__ ()\n\ 4049 @deftypefn {} {@var{val} =} __compactformat__ ()\n\
4050 @deftypefnx {Built-in Function} {} __compactformat__ (@var{TRUE|FALSE})\n\ 4050 @deftypefnx {} {} __compactformat__ (@var{TRUE|FALSE})\n\
4051 Undocumented internal function\n\ 4051 Undocumented internal function\n\
4052 @end deftypefn") 4052 @end deftypefn")
4053 { 4053 {
4054 return SET_INTERNAL_VARIABLE (compact_format); 4054 return SET_INTERNAL_VARIABLE (compact_format);
4055 } 4055 }
4056 4056
4057 DEFUN (__formatstring__, , , 4057 DEFUN (__formatstring__, , ,
4058 "-*- texinfo -*-\n\ 4058 "-*- texinfo -*-\n\
4059 @deftypefn {Built-in Function} {@var{val} =} __formatstring__ ()\n\ 4059 @deftypefn {} {@var{val} =} __formatstring__ ()\n\
4060 Undocumented internal function\n\ 4060 Undocumented internal function\n\
4061 @end deftypefn") 4061 @end deftypefn")
4062 { 4062 {
4063 return ovl (format_string); 4063 return ovl (format_string);
4064 } 4064 }
4065 4065
4066 DEFUN (fixed_point_format, args, nargout, 4066 DEFUN (fixed_point_format, args, nargout,
4067 "-*- texinfo -*-\n\ 4067 "-*- texinfo -*-\n\
4068 @deftypefn {Built-in Function} {@var{val} =} fixed_point_format ()\n\ 4068 @deftypefn {} {@var{val} =} fixed_point_format ()\n\
4069 @deftypefnx {Built-in Function} {@var{old_val} =} fixed_point_format (@var{new_val})\n\ 4069 @deftypefnx {} {@var{old_val} =} fixed_point_format (@var{new_val})\n\
4070 @deftypefnx {Built-in Function} {} fixed_point_format (@var{new_val}, \"local\")\n\ 4070 @deftypefnx {} {} fixed_point_format (@var{new_val}, \"local\")\n\
4071 Query or set the internal variable that controls whether Octave will\n\ 4071 Query or set the internal variable that controls whether Octave will\n\
4072 use a scaled format to print matrix values.\n\ 4072 use a scaled format to print matrix values.\n\
4073 \n\ 4073 \n\
4074 The scaled format prints a scaling factor on the first line of output chosen\n\ 4074 The scaled format prints a scaling factor on the first line of output chosen\n\
4075 such that the largest matrix element can be written with a single leading\n\ 4075 such that the largest matrix element can be written with a single leading\n\
4104 return SET_INTERNAL_VARIABLE (fixed_point_format); 4104 return SET_INTERNAL_VARIABLE (fixed_point_format);
4105 } 4105 }
4106 4106
4107 DEFUN (print_empty_dimensions, args, nargout, 4107 DEFUN (print_empty_dimensions, args, nargout,
4108 "-*- texinfo -*-\n\ 4108 "-*- texinfo -*-\n\
4109 @deftypefn {Built-in Function} {@var{val} =} print_empty_dimensions ()\n\ 4109 @deftypefn {} {@var{val} =} print_empty_dimensions ()\n\
4110 @deftypefnx {Built-in Function} {@var{old_val} =} print_empty_dimensions (@var{new_val})\n\ 4110 @deftypefnx {} {@var{old_val} =} print_empty_dimensions (@var{new_val})\n\
4111 @deftypefnx {Built-in Function} {} print_empty_dimensions (@var{new_val}, \"local\")\n\ 4111 @deftypefnx {} {} print_empty_dimensions (@var{new_val}, \"local\")\n\
4112 Query or set the internal variable that controls whether the dimensions of\n\ 4112 Query or set the internal variable that controls whether the dimensions of\n\
4113 empty matrices are printed along with the empty matrix symbol, @samp{[]}.\n\ 4113 empty matrices are printed along with the empty matrix symbol, @samp{[]}.\n\
4114 \n\ 4114 \n\
4115 For example, the expression\n\ 4115 For example, the expression\n\
4116 \n\ 4116 \n\
4134 return SET_INTERNAL_VARIABLE (print_empty_dimensions); 4134 return SET_INTERNAL_VARIABLE (print_empty_dimensions);
4135 } 4135 }
4136 4136
4137 DEFUN (split_long_rows, args, nargout, 4137 DEFUN (split_long_rows, args, nargout,
4138 "-*- texinfo -*-\n\ 4138 "-*- texinfo -*-\n\
4139 @deftypefn {Built-in Function} {@var{val} =} split_long_rows ()\n\ 4139 @deftypefn {} {@var{val} =} split_long_rows ()\n\
4140 @deftypefnx {Built-in Function} {@var{old_val} =} split_long_rows (@var{new_val})\n\ 4140 @deftypefnx {} {@var{old_val} =} split_long_rows (@var{new_val})\n\
4141 @deftypefnx {Built-in Function} {} split_long_rows (@var{new_val}, \"local\")\n\ 4141 @deftypefnx {} {} split_long_rows (@var{new_val}, \"local\")\n\
4142 Query or set the internal variable that controls whether rows of a matrix\n\ 4142 Query or set the internal variable that controls whether rows of a matrix\n\
4143 may be split when displayed to a terminal window.\n\ 4143 may be split when displayed to a terminal window.\n\
4144 \n\ 4144 \n\
4145 If the rows are split, Octave will display the matrix in a series of smaller\n\ 4145 If the rows are split, Octave will display the matrix in a series of smaller\n\
4146 pieces, each of which can fit within the limits of your terminal width and\n\ 4146 pieces, each of which can fit within the limits of your terminal width and\n\
4173 return SET_INTERNAL_VARIABLE (split_long_rows); 4173 return SET_INTERNAL_VARIABLE (split_long_rows);
4174 } 4174 }
4175 4175
4176 DEFUN (output_max_field_width, args, nargout, 4176 DEFUN (output_max_field_width, args, nargout,
4177 "-*- texinfo -*-\n\ 4177 "-*- texinfo -*-\n\
4178 @deftypefn {Built-in Function} {@var{val} =} output_max_field_width ()\n\ 4178 @deftypefn {} {@var{val} =} output_max_field_width ()\n\
4179 @deftypefnx {Built-in Function} {@var{old_val} =} output_max_field_width (@var{new_val})\n\ 4179 @deftypefnx {} {@var{old_val} =} output_max_field_width (@var{new_val})\n\
4180 @deftypefnx {Built-in Function} {} output_max_field_width (@var{new_val}, \"local\")\n\ 4180 @deftypefnx {} {} output_max_field_width (@var{new_val}, \"local\")\n\
4181 Query or set the internal variable that specifies the maximum width\n\ 4181 Query or set the internal variable that specifies the maximum width\n\
4182 of a numeric output field.\n\ 4182 of a numeric output field.\n\
4183 \n\ 4183 \n\
4184 When called from inside a function with the @qcode{\"local\"} option, the\n\ 4184 When called from inside a function with the @qcode{\"local\"} option, the\n\
4185 variable is changed locally for the function and any subroutines it calls.\n\ 4185 variable is changed locally for the function and any subroutines it calls.\n\
4191 std::numeric_limits<int>::max ()); 4191 std::numeric_limits<int>::max ());
4192 } 4192 }
4193 4193
4194 DEFUN (output_precision, args, nargout, 4194 DEFUN (output_precision, args, nargout,
4195 "-*- texinfo -*-\n\ 4195 "-*- texinfo -*-\n\
4196 @deftypefn {Built-in Function} {@var{val} =} output_precision ()\n\ 4196 @deftypefn {} {@var{val} =} output_precision ()\n\
4197 @deftypefnx {Built-in Function} {@var{old_val} =} output_precision (@var{new_val})\n\ 4197 @deftypefnx {} {@var{old_val} =} output_precision (@var{new_val})\n\
4198 @deftypefnx {Built-in Function} {} output_precision (@var{new_val}, \"local\")\n\ 4198 @deftypefnx {} {} output_precision (@var{new_val}, \"local\")\n\
4199 Query or set the internal variable that specifies the minimum number of\n\ 4199 Query or set the internal variable that specifies the minimum number of\n\
4200 significant figures to display for numeric output.\n\ 4200 significant figures to display for numeric output.\n\
4201 \n\ 4201 \n\
4202 When called from inside a function with the @qcode{\"local\"} option, the\n\ 4202 When called from inside a function with the @qcode{\"local\"} option, the\n\
4203 variable is changed locally for the function and any subroutines it calls.\n\ 4203 variable is changed locally for the function and any subroutines it calls.\n\