octave: libinterp/corefcn/pr-output.cc comparison

comparison libinterp/corefcn/pr-output.cc @ 21966:112b20240c87

move docstrings in C++ files out of C strings and into comments * __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc, __ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc, bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc, load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc, oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc, pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc, sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc, audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc, ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc, ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc, pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy: Docstrings are now comments instead of C strings. * build-aux/mk-opts.pl: Emit docstrings as comments instead of C strings. * DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments. * builtins.h: Include builtin-defun-decls.h unconditionally. * defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration. (DEFALIAS): Always expand to nothing. * defun-dld.h: No special macro expansions for MAKE_BUILTINS. (DEFUN_DLD): Use FORWARD_DECLARE_FUN. (DEFUNX_DLD): Use FORWARD_DECLARE_FUNX. * defun-int.h: No special macro expansions for MAKE_BUILTINS. (FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros. (DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass "external-doc" to DEFINE_FUNX_INSTALLER_FUN. (DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL, DEFALIAS_INTERNAL): Delete. * common.mk (move_if_change_rule): New macro. (simple_move_if_change_rule): Define using move_if_change_rule. * find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file name extension to ".df". * libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files. * mkbuiltins: New argument, SRCDIR. Operate directly on source files. * mkdefs: Delete. * libinterp/module.mk (BUILT_SOURCES): Update list to contain only files included in other source files. (GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete. (LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here. (LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from the list. (libinterp_EXTRA_DIST): Remove mkdefs from the list. (FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES. (DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES. (SRC_DEFUN_FILES): Rename from SRC_DEF_FILES. (ALL_DEFUN_FILES): Rename from ALL_DEF_FILES. (%.df: %.cc): Delete pattern rule. (libinterp/build-env-features.cc, libinterp/builtins.cc, libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change. (libinterp/builtins.cc, libinterp/builtin-defun-decls.h): Update mkbuiltins command. ($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command. * liboctave/module.mk (BUILT_SOURCES): Don't include liboctave-build-info.cc in the list.

author	John W. Eaton <jwe@octave.org>
date	Tue, 21 Jun 2016 16:07:51 -0400
parents	aab79a1885cc
children	278fc29b69ca

comparison

equal deleted inserted replaced

-:da218a61ce4a
+:112b20240c87
 {
 panic_impossible ();
 }
 DEFUN (rats, args, ,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn {} {} rats (@var{x}, @var{len})\n\
+@deftypefn {} {} rats (@var{x}, @var{len})
-Convert @var{x} into a rational approximation represented as a string.\n\
+Convert @var{x} into a rational approximation represented as a string.
-\n\
-The string can be converted back into a matrix as follows:\n\
+The string can be converted back into a matrix as follows:
-\n\
-@example\n\
+@example
-@group\n\
+@group
-r = rats (hilb (4));\n\
+r = rats (hilb (4));
-x = str2num (r)\n\
+x = str2num (r)
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-The optional second argument defines the maximum length of the string\n\
+The optional second argument defines the maximum length of the string
-representing the elements of @var{x}.  By default @var{len} is 9.\n\
+representing the elements of @var{x}.  By default @var{len} is 9.
-\n\
-If the length of the smallest possible rational approximation exceeds\n\
+If the length of the smallest possible rational approximation exceeds
-@var{len}, an asterisk (*) padded with spaces will be returned instead.\n\
+@var{len}, an asterisk (*) padded with spaces will be returned instead.
-@seealso{format, rat}\n\
+@seealso{format, rat}
-@end deftypefn")
+@end deftypefn */)
 {
 int nargin = args.length ();
 if (nargin < 1 || nargin > 2)
 print_usage ();
 return ovl (string_vector (lst));
 }
 DEFUN (disp, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn {} {} disp (@var{x})\n\
+@deftypefn {} {} disp (@var{x})
-Display the value of @var{x}.\n\
+Display the value of @var{x}.
-\n\
-For example:\n\
+For example:
-\n\
-@example\n\
+@example
-@group\n\
+@group
-disp (\"The value of pi is:\"), disp (pi)\n\
+disp ("The value of pi is:"), disp (pi)
-\n\
-@print{} the value of pi is:\n\
+@print{} the value of pi is:
-@print{} 3.1416\n\
+@print{} 3.1416
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-@noindent\n\
+@noindent
-Note that the output from @code{disp} always ends with a newline.\n\
+Note that the output from @code{disp} always ends with a newline.
-\n\
-If an output value is requested, @code{disp} prints nothing and returns the\n\
+If an output value is requested, @code{disp} prints nothing and returns the
-formatted output in a string.\n\
+formatted output in a string.
-@seealso{fdisp}\n\
+@seealso{fdisp}
-@end deftypefn")
+@end deftypefn */)
 {
 if (args.length () != 1)
 print_usage ();
 octave_value_list retval;
 return retval;
 }
 DEFUN (fdisp, args, ,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn {} {} fdisp (@var{fid}, @var{x})\n\
+@deftypefn {} {} fdisp (@var{fid}, @var{x})
-Display the value of @var{x} on the stream @var{fid}.\n\
+Display the value of @var{x} on the stream @var{fid}.
-\n\
-For example:\n\
+For example:
-\n\
-@example\n\
+@example
-@group\n\
+@group
-fdisp (stdout, \"The value of pi is:\"), fdisp (stdout, pi)\n\
+fdisp (stdout, "The value of pi is:"), fdisp (stdout, pi)
-\n\
-@print{} the value of pi is:\n\
+@print{} the value of pi is:
-@print{} 3.1416\n\
+@print{} 3.1416
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-@noindent\n\
+@noindent
-Note that the output from @code{fdisp} always ends with a newline.\n\
+Note that the output from @code{fdisp} always ends with a newline.
-@seealso{disp}\n\
+@seealso{disp}
-@end deftypefn")
+@end deftypefn */)
 {
 if (args.length () != 2)
 print_usage ();
 int fid = octave_stream_list::get_file_number (args(0));
 format_string = format;
 }
 DEFUN (format, args, ,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {} format\n\
+@deftypefn  {} {} format
-@deftypefnx {} {} format options\n\
+@deftypefnx {} {} format options
-Reset or specify the format of the output produced by @code{disp} and\n\
+Reset or specify the format of the output produced by @code{disp} and
-Octave's normal echoing mechanism.\n\
+Octave's normal echoing mechanism.
-\n\
-This command only affects the display of numbers but not how they are stored\n\
+This command only affects the display of numbers but not how they are stored
-or computed.  To change the internal representation from the default double\n\
+or computed.  To change the internal representation from the default double
-use one of the conversion functions such as @code{single}, @code{uint8},\n\
+use one of the conversion functions such as @code{single}, @code{uint8},
-@code{int64}, etc.\n\
+@code{int64}, etc.
-\n\
-By default, Octave displays 5 significant digits in a human readable form\n\
+By default, Octave displays 5 significant digits in a human readable form
-(option @samp{short} paired with @samp{loose} format for matrices).\n\
+(option @samp{short} paired with @samp{loose} format for matrices).
-If @code{format} is invoked without any options, this default format\n\
+If @code{format} is invoked without any options, this default format
-is restored.\n\
+is restored.
-\n\
-Valid formats for floating point numbers are listed in the following\n\
+Valid formats for floating point numbers are listed in the following
-table.\n\
+table.
-\n\
-@table @code\n\
+@table @code
-@item short\n\
+@item short
-Fixed point format with 5 significant figures in a field that is a maximum\n\
+Fixed point format with 5 significant figures in a field that is a maximum
-of 10 characters wide.  (default).\n\
+of 10 characters wide.  (default).
-\n\
-If Octave is unable to format a matrix so that columns line up on the\n\
+If Octave is unable to format a matrix so that columns line up on the
-decimal point and all numbers fit within the maximum field width then\n\
+decimal point and all numbers fit within the maximum field width then
-it switches to an exponential @samp{e} format.\n\
+it switches to an exponential @samp{e} format.
-\n\
-@item long\n\
+@item long
-Fixed point format with 15 significant figures in a field that is a maximum\n\
+Fixed point format with 15 significant figures in a field that is a maximum
-of 20 characters wide.\n\
+of 20 characters wide.
-\n\
-As with the @samp{short} format, Octave will switch to an exponential\n\
+As with the @samp{short} format, Octave will switch to an exponential
-@samp{e} format if it is unable to format a matrix properly using the\n\
+@samp{e} format if it is unable to format a matrix properly using the
-current format.\n\
+current format.
-\n\
-@item  short e\n\
+@item  short e
-@itemx long e\n\
+@itemx long e
-Exponential format.  The number to be represented is split between a\n\
+Exponential format.  The number to be represented is split between a
-mantissa and an exponent (power of 10).  The mantissa has 5 significant\n\
+mantissa and an exponent (power of 10).  The mantissa has 5 significant
-digits in the short format and 15 digits in the long format.  For example,\n\
+digits in the short format and 15 digits in the long format.  For example,
-with the @samp{short e} format, @code{pi} is displayed as\n\
+with the @samp{short e} format, @code{pi} is displayed as
-@code{3.1416e+00}.\n\
+@code{3.1416e+00}.
-\n\
-@item  short E\n\
+@item  short E
-@itemx long E\n\
+@itemx long E
-Identical to @samp{short e} or @samp{long e} but displays an uppercase\n\
+Identical to @samp{short e} or @samp{long e} but displays an uppercase
-@samp{E} to indicate the exponent.\n\
+@samp{E} to indicate the exponent.
-For example, with the @samp{long E} format, @code{pi} is displayed as\n\
+For example, with the @samp{long E} format, @code{pi} is displayed as
-@code{3.14159265358979E+00}.\n\
+@code{3.14159265358979E+00}.
-\n\
-@item  short g\n\
+@item  short g
-@itemx long g\n\
+@itemx long g
-Optimally choose between fixed point and exponential format based on\n\
+Optimally choose between fixed point and exponential format based on
-the magnitude of the number.\n\
+the magnitude of the number.
-For example, with the @samp{short g} format,\n\
+For example, with the @samp{short g} format,
-@code{pi .^ [2; 4; 8; 16; 32]} is displayed as\n\
+@code{pi .^ [2; 4; 8; 16; 32]} is displayed as
-\n\
-@example\n\
+@example
-@group\n\
+@group
-ans =\n\
+ans =
-\n\
-9.8696\n\
+9.8696
-97.409\n\
+97.409
-9488.5\n\
+9488.5
-9.0032e+07\n\
+9.0032e+07
-8.1058e+15\n\
+8.1058e+15
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-@item  short eng\n\
+@item  short eng
-@itemx long eng\n\
+@itemx long eng
-Identical to @samp{short e} or @samp{long e} but displays the value\n\
+Identical to @samp{short e} or @samp{long e} but displays the value
-using an engineering format, where the exponent is divisible by 3.  For\n\
+using an engineering format, where the exponent is divisible by 3.  For
-example, with the @samp{short eng} format, @code{10 * pi} is displayed as\n\
+example, with the @samp{short eng} format, @code{10 * pi} is displayed as
-@code{31.4159e+00}.\n\
+@code{31.4159e+00}.
-\n\
-@item  long G\n\
+@item  long G
-@itemx short G\n\
+@itemx short G
-Identical to @samp{short g} or @samp{long g} but displays an uppercase\n\
+Identical to @samp{short g} or @samp{long g} but displays an uppercase
-@samp{E} to indicate the exponent.\n\
+@samp{E} to indicate the exponent.
-\n\
-@item  free\n\
+@item  free
-@itemx none\n\
+@itemx none
-Print output in free format, without trying to line up columns of\n\
+Print output in free format, without trying to line up columns of
-matrices on the decimal point.  This also causes complex numbers to be\n\
+matrices on the decimal point.  This also causes complex numbers to be
-formatted as numeric pairs like this @samp{(0.60419, 0.60709)} instead\n\
+formatted as numeric pairs like this @samp{(0.60419, 0.60709)} instead
-of like this @samp{0.60419 + 0.60709i}.\n\
+of like this @samp{0.60419 + 0.60709i}.
-@end table\n\
+@end table
-\n\
-The following formats affect all numeric output (floating point and\n\
+The following formats affect all numeric output (floating point and
-integer types).\n\
+integer types).
-\n\
-@table @code\n\
+@table @code
-@item  \"+\"\n\
+@item  "+"
-@itemx \"+\" @var{chars}\n\
+@itemx "+" @var{chars}
-@itemx plus\n\
+@itemx plus
-@itemx plus @var{chars}\n\
+@itemx plus @var{chars}
-Print a @samp{+} symbol for matrix elements greater than zero, a\n\
+Print a @samp{+} symbol for matrix elements greater than zero, a
-@samp{-} symbol for elements less than zero and a space for zero matrix\n\
+@samp{-} symbol for elements less than zero and a space for zero matrix
-elements.  This format can be very useful for examining the structure\n\
+elements.  This format can be very useful for examining the structure
-of a large sparse matrix.\n\
+of a large sparse matrix.
-\n\
-The optional argument @var{chars} specifies a list of 3 characters to use\n\
+The optional argument @var{chars} specifies a list of 3 characters to use
-for printing values greater than zero, less than zero and equal to zero.\n\
+for printing values greater than zero, less than zero and equal to zero.
-For example, with the @samp{\"+\" \"+-.\"} format,\n\
+For example, with the @samp{"+" "+-."} format,
-@code{[1, 0, -1; -1, 0, 1]} is displayed as\n\
+@code{[1, 0, -1; -1, 0, 1]} is displayed as
-\n\
-@example\n\
+@example
-@group\n\
+@group
-ans =\n\
+ans =
-\n\
-+.-\n\
++.-
--.+\n\
+-.+
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-@item bank\n\
+@item bank
-Print in a fixed format with two digits to the right of the decimal\n\
+Print in a fixed format with two digits to the right of the decimal
-point.\n\
+point.
-\n\
-@item native-hex\n\
+@item native-hex
-Print the hexadecimal representation of numbers as they are stored in\n\
+Print the hexadecimal representation of numbers as they are stored in
-memory.  For example, on a workstation which stores 8 byte real values\n\
+memory.  For example, on a workstation which stores 8 byte real values
-in IEEE format with the least significant byte first, the value of\n\
+in IEEE format with the least significant byte first, the value of
-@code{pi} when printed in @code{native-hex} format is\n\
+@code{pi} when printed in @code{native-hex} format is
-@code{400921fb54442d18}.\n\
+@code{400921fb54442d18}.
-\n\
-@item hex\n\
+@item hex
-The same as @code{native-hex}, but always print the most significant\n\
+The same as @code{native-hex}, but always print the most significant
-byte first.\n\
+byte first.
-\n\
-@item native-bit\n\
+@item native-bit
-Print the bit representation of numbers as stored in memory.\n\
+Print the bit representation of numbers as stored in memory.
-For example, the value of @code{pi} is\n\
+For example, the value of @code{pi} is
-\n\
-@example\n\
+@example
-@group\n\
+@group
-01000000000010010010000111111011\n\
+01000000000010010010000111111011
-01010100010001000010110100011000\n\
+01010100010001000010110100011000
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-(shown here in two 32 bit sections for typesetting purposes) when\n\
+(shown here in two 32 bit sections for typesetting purposes) when
-printed in native-bit format on a workstation which stores 8 byte real\n\
+printed in native-bit format on a workstation which stores 8 byte real
-values in IEEE format with the least significant byte first.\n\
+values in IEEE format with the least significant byte first.
-\n\
-@item bit\n\
+@item bit
-The same as @code{native-bit}, but always print the most significant\n\
+The same as @code{native-bit}, but always print the most significant
-bits first.\n\
+bits first.
-\n\
-@item rat\n\
+@item rat
-Print a rational approximation, i.e., values are approximated\n\
+Print a rational approximation, i.e., values are approximated
-as the ratio of small integers.\n\
+as the ratio of small integers.
-For example, with the @samp{rat} format,\n\
+For example, with the @samp{rat} format,
-@code{pi} is displayed as @code{355/113}.\n\
+@code{pi} is displayed as @code{355/113}.
-@end table\n\
+@end table
-\n\
-The following two options affect the display of all matrices.\n\
+The following two options affect the display of all matrices.
-\n\
-@table @code\n\
+@table @code
-@item compact\n\
+@item compact
-Remove blank lines around column number labels and between\n\
+Remove blank lines around column number labels and between
-matrices producing more compact output with more data per page.\n\
+matrices producing more compact output with more data per page.
-\n\
-@item loose\n\
+@item loose
-Insert blank lines above and below column number labels and between matrices\n\
+Insert blank lines above and below column number labels and between matrices
-to produce a more readable output with less data per page.  (default).\n\
+to produce a more readable output with less data per page.  (default).
-@end table\n\
+@end table
-@seealso{fixed_point_format, output_max_field_width, output_precision, split_long_rows, print_empty_dimensions, rats}\n\
+@seealso{fixed_point_format, output_max_field_width, output_precision, split_long_rows, print_empty_dimensions, rats}
-@end deftypefn")
+@end deftypefn */)
 {
 int argc = args.length () + 1;
 string_vector argv = args.make_argv ("format");
 return ovl ();
 }
 DEFUN (__compactformat__, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{val} =} __compactformat__ ()\n\
+@deftypefn  {} {@var{val} =} __compactformat__ ()
-@deftypefnx {} {} __compactformat__ (@var{TRUE|FALSE})\n\
+@deftypefnx {} {} __compactformat__ (@var{TRUE|FALSE})
-Undocumented internal function\n\
+Undocumented internal function
-@end deftypefn")
+@end deftypefn */)
 {
 return SET_INTERNAL_VARIABLE (compact_format);
 }
 DEFUN (__formatstring__, , ,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn {} {@var{val} =} __formatstring__ ()\n\
+@deftypefn {} {@var{val} =} __formatstring__ ()
-Undocumented internal function\n\
+Undocumented internal function
-@end deftypefn")
+@end deftypefn */)
 {
 return ovl (format_string);
 }
 DEFUN (fixed_point_format, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{val} =} fixed_point_format ()\n\
+@deftypefn  {} {@var{val} =} fixed_point_format ()
-@deftypefnx {} {@var{old_val} =} fixed_point_format (@var{new_val})\n\
+@deftypefnx {} {@var{old_val} =} fixed_point_format (@var{new_val})
-@deftypefnx {} {} fixed_point_format (@var{new_val}, \"local\")\n\
+@deftypefnx {} {} fixed_point_format (@var{new_val}, "local")
-Query or set the internal variable that controls whether Octave will\n\
+Query or set the internal variable that controls whether Octave will
-use a scaled format to print matrix values.\n\
+use a scaled format to print matrix values.
-\n\
-The scaled format prints a scaling factor on the first line of output chosen\n\
+The scaled format prints a scaling factor on the first line of output chosen
-such that the largest matrix element can be written with a single leading\n\
+such that the largest matrix element can be written with a single leading
-digit.  For example:\n\
+digit.  For example:
-\n\
-@example\n\
+@example
-@group\n\
+@group
-logspace (1, 7, 5)'\n\
+logspace (1, 7, 5)'
-ans =\n\
+ans =
-\n\
-1.0e+07  *\n\
+1.0e+07  *
-\n\
-0.00000\n\
+0.00000
-0.00003\n\
+0.00003
-0.00100\n\
+0.00100
-0.03162\n\
+0.03162
-1.00000\n\
+1.00000
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-@noindent\n\
+@noindent
-Notice that the first value appears to be 0 when it is actually 1.  Because\n\
+Notice that the first value appears to be 0 when it is actually 1.  Because
-of the possibility for confusion you should be careful about enabling\n\
+of the possibility for confusion you should be careful about enabling
-@code{fixed_point_format}.\n\
+@code{fixed_point_format}.
-\n\
-When called from inside a function with the @qcode{\"local\"} option, the\n\
+When called from inside a function with the @qcode{"local"} option, the
-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.
-The original variable value is restored when exiting the function.\n\
+The original variable value is restored when exiting the function.
-@seealso{format, output_max_field_width, output_precision}\n\
+@seealso{format, output_max_field_width, output_precision}
-@end deftypefn")
+@end deftypefn */)
 {
 return SET_INTERNAL_VARIABLE (fixed_point_format);
 }
 DEFUN (print_empty_dimensions, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{val} =} print_empty_dimensions ()\n\
+@deftypefn  {} {@var{val} =} print_empty_dimensions ()
-@deftypefnx {} {@var{old_val} =} print_empty_dimensions (@var{new_val})\n\
+@deftypefnx {} {@var{old_val} =} print_empty_dimensions (@var{new_val})
-@deftypefnx {} {} print_empty_dimensions (@var{new_val}, \"local\")\n\
+@deftypefnx {} {} print_empty_dimensions (@var{new_val}, "local")
-Query or set the internal variable that controls whether the dimensions of\n\
+Query or set the internal variable that controls whether the dimensions of
-empty matrices are printed along with the empty matrix symbol, @samp{[]}.\n\
+empty matrices are printed along with the empty matrix symbol, @samp{[]}.
-\n\
-For example, the expression\n\
+For example, the expression
-\n\
-@example\n\
+@example
-zeros (3, 0)\n\
+zeros (3, 0)
-@end example\n\
+@end example
-\n\
-@noindent\n\
+@noindent
-will print\n\
+will print
-\n\
-@example\n\
+@example
-ans = [](3x0)\n\
+ans = [](3x0)
-@end example\n\
+@end example
-\n\
-When called from inside a function with the @qcode{\"local\"} option, the\n\
+When called from inside a function with the @qcode{"local"} option, the
-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.
-The original variable value is restored when exiting the function.\n\
+The original variable value is restored when exiting the function.
-@seealso{format}\n\
+@seealso{format}
-@end deftypefn")
+@end deftypefn */)
 {
 return SET_INTERNAL_VARIABLE (print_empty_dimensions);
 }
 DEFUN (split_long_rows, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{val} =} split_long_rows ()\n\
+@deftypefn  {} {@var{val} =} split_long_rows ()
-@deftypefnx {} {@var{old_val} =} split_long_rows (@var{new_val})\n\
+@deftypefnx {} {@var{old_val} =} split_long_rows (@var{new_val})
-@deftypefnx {} {} split_long_rows (@var{new_val}, \"local\")\n\
+@deftypefnx {} {} split_long_rows (@var{new_val}, "local")
-Query or set the internal variable that controls whether rows of a matrix\n\
+Query or set the internal variable that controls whether rows of a matrix
-may be split when displayed to a terminal window.\n\
+may be split when displayed to a terminal window.
-\n\
-If the rows are split, Octave will display the matrix in a series of smaller\n\
+If the rows are split, Octave will display the matrix in a series of smaller
-pieces, each of which can fit within the limits of your terminal width and\n\
+pieces, each of which can fit within the limits of your terminal width and
-each set of rows is labeled so that you can easily see which columns are\n\
+each set of rows is labeled so that you can easily see which columns are
-currently being displayed.  For example:\n\
+currently being displayed.  For example:
-\n\
-@example\n\
+@example
-@group\n\
+@group
-octave:13> rand (2,10)\n\
+octave:13> rand (2,10)
-ans =\n\
+ans =
-\n\
-Columns 1 through 6:\n\
+Columns 1 through 6:
-\n\
-0.75883  0.93290  0.40064  0.43818  0.94958  0.16467\n\
+0.75883  0.93290  0.40064  0.43818  0.94958  0.16467
-0.75697  0.51942  0.40031  0.61784  0.92309  0.40201\n\
+0.75697  0.51942  0.40031  0.61784  0.92309  0.40201
-\n\
-Columns 7 through 10:\n\
+Columns 7 through 10:
-\n\
-0.90174  0.11854  0.72313  0.73326\n\
+0.90174  0.11854  0.72313  0.73326
-0.44672  0.94303  0.56564  0.82150\n\
+0.44672  0.94303  0.56564  0.82150
-@end group\n\
+@end group
-@end example\n\
+@end example
-\n\
-When called from inside a function with the @qcode{\"local\"} option, the\n\
+When called from inside a function with the @qcode{"local"} option, the
-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.
-The original variable value is restored when exiting the function.\n\
+The original variable value is restored when exiting the function.
-@seealso{format}\n\
+@seealso{format}
-@end deftypefn")
+@end deftypefn */)
 {
 return SET_INTERNAL_VARIABLE (split_long_rows);
 }
 DEFUN (output_max_field_width, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{val} =} output_max_field_width ()\n\
+@deftypefn  {} {@var{val} =} output_max_field_width ()
-@deftypefnx {} {@var{old_val} =} output_max_field_width (@var{new_val})\n\
+@deftypefnx {} {@var{old_val} =} output_max_field_width (@var{new_val})
-@deftypefnx {} {} output_max_field_width (@var{new_val}, \"local\")\n\
+@deftypefnx {} {} output_max_field_width (@var{new_val}, "local")
-Query or set the internal variable that specifies the maximum width\n\
+Query or set the internal variable that specifies the maximum width
-of a numeric output field.\n\
+of a numeric output field.
-\n\
-When called from inside a function with the @qcode{\"local\"} option, the\n\
+When called from inside a function with the @qcode{"local"} option, the
-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.
-The original variable value is restored when exiting the function.\n\
+The original variable value is restored when exiting the function.
-@seealso{format, fixed_point_format, output_precision}\n\
+@seealso{format, fixed_point_format, output_precision}
-@end deftypefn")
+@end deftypefn */)
 {
 return SET_INTERNAL_VARIABLE_WITH_LIMITS (output_max_field_width, 0,
 std::numeric_limits<int>::max ());
 }
 DEFUN (output_precision, args, nargout,
-"-*- texinfo -*-\n\
+doc: /* -*- texinfo -*-
-@deftypefn  {} {@var{val} =} output_precision ()\n\
+@deftypefn  {} {@var{val} =} output_precision ()
-@deftypefnx {} {@var{old_val} =} output_precision (@var{new_val})\n\
+@deftypefnx {} {@var{old_val} =} output_precision (@var{new_val})
-@deftypefnx {} {} output_precision (@var{new_val}, \"local\")\n\
+@deftypefnx {} {} output_precision (@var{new_val}, "local")
-Query or set the internal variable that specifies the minimum number of\n\
+Query or set the internal variable that specifies the minimum number of
-significant figures to display for numeric output.\n\
+significant figures to display for numeric output.
-\n\
-When called from inside a function with the @qcode{\"local\"} option, the\n\
+When called from inside a function with the @qcode{"local"} option, the
-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.
-The original variable value is restored when exiting the function.\n\
+The original variable value is restored when exiting the function.
-@seealso{format, fixed_point_format, output_max_field_width}\n\
+@seealso{format, fixed_point_format, output_max_field_width}
-@end deftypefn")
+@end deftypefn */)
 {
 return SET_INTERNAL_VARIABLE_WITH_LIMITS (output_precision, -1,
 std::numeric_limits<int>::max ());
 }

Mercurial > octave

comparison libinterp/corefcn/pr-output.cc @ 21966:112b20240c87