Mercurial > octave
diff libinterp/octave-value/ov.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 | c4ab2e54f100 |
children | efce657ceb86 |
line wrap: on
line diff
--- a/libinterp/octave-value/ov.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/octave-value/ov.cc Tue Jun 21 16:07:51 2016 -0400 @@ -2713,11 +2713,11 @@ } DEFUN (sizeof, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} sizeof (@var{val})\n\ -Return the size of @var{val} in bytes.\n\ -@seealso{whos}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} sizeof (@var{val}) +Return the size of @var{val} in bytes. +@seealso{whos} +@end deftypefn */) { if (args.length () != 1) print_usage (); @@ -2791,40 +2791,40 @@ } DEFUN (subsref, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {} subsref (@var{val}, @var{idx})\n\ -Perform the subscripted element selection operation on @var{val} according\n\ -to the subscript specified by @var{idx}.\n\ -\n\ -The subscript @var{idx} must be a structure array with fields @samp{type}\n\ -and @samp{subs}. Valid values for @samp{type} are @qcode{\"()\"},\n\ -@qcode{\"@{@}\"}, and @qcode{\".\"}. The @samp{subs} field may be either\n\ -@qcode{\":\"} or a cell array of index values.\n\ -\n\ -The following example shows how to extract the first two columns of a matrix\n\ -\n\ -@example\n\ -@group\n\ -val = magic (3)\n\ - @result{} val = [ 8 1 6\n\ - 3 5 7\n\ - 4 9 2 ]\n\ -idx.type = \"()\";\n\ -idx.subs = @{\":\", 1:2@};\n\ -subsref (val, idx)\n\ - @result{} [ 8 1\n\ - 3 5\n\ - 4 9 ]\n\ -@end group\n\ -@end example\n\ -\n\ -@noindent\n\ -Note that this is the same as writing @code{val(:, 1:2)}.\n\ -\n\ -If @var{idx} is an empty structure array with fields @samp{type} and\n\ -@samp{subs}, return @var{val}.\n\ -@seealso{subsasgn, substruct}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} subsref (@var{val}, @var{idx}) +Perform the subscripted element selection operation on @var{val} according +to the subscript specified by @var{idx}. + +The subscript @var{idx} must be a structure array with fields @samp{type} +and @samp{subs}. Valid values for @samp{type} are @qcode{"()"}, +@qcode{"@{@}"}, and @qcode{"."}. The @samp{subs} field may be either +@qcode{":"} or a cell array of index values. + +The following example shows how to extract the first two columns of a matrix + +@example +@group +val = magic (3) + @result{} val = [ 8 1 6 + 3 5 7 + 4 9 2 ] +idx.type = "()"; +idx.subs = @{":", 1:2@}; +subsref (val, idx) + @result{} [ 8 1 + 3 5 + 4 9 ] +@end group +@end example + +@noindent +Note that this is the same as writing @code{val(:, 1:2)}. + +If @var{idx} is an empty structure array with fields @samp{type} and +@samp{subs}, return @var{val}. +@seealso{subsasgn, substruct} +@end deftypefn */) { if (args.length () != 2) print_usage (); @@ -2843,37 +2843,37 @@ } DEFUN (subsasgn, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} subsasgn (@var{val}, @var{idx}, @var{rhs})\n\ -Perform the subscripted assignment operation according to the subscript\n\ -specified by @var{idx}.\n\ -\n\ -The subscript @var{idx} must be a structure array with fields @samp{type}\n\ -and @samp{subs}. Valid values for @samp{type} are @qcode{\"()\"},\n\ -@qcode{\"@{@}\"}, and @qcode{\".\"}. The @samp{subs} field may be either\n\ -@qcode{\":\"} or a cell array of index values.\n\ -\n\ -The following example shows how to set the two first columns of a 3-by-3\n\ -matrix to zero.\n\ -\n\ -@example\n\ -@group\n\ -val = magic (3);\n\ -idx.type = \"()\";\n\ -idx.subs = @{\":\", 1:2@};\n\ -subsasgn (val, idx, 0)\n\ - @result{} [ 0 0 6\n\ - 0 0 7\n\ - 0 0 2 ]\n\ -@end group\n\ -@end example\n\ -\n\ -Note that this is the same as writing @code{val(:, 1:2) = 0}.\n\ -\n\ -If @var{idx} is an empty structure array with fields @samp{type} and\n\ -@samp{subs}, return @var{rhs}.\n\ -@seealso{subsref, substruct, optimize_subsasgn_calls}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} subsasgn (@var{val}, @var{idx}, @var{rhs}) +Perform the subscripted assignment operation according to the subscript +specified by @var{idx}. + +The subscript @var{idx} must be a structure array with fields @samp{type} +and @samp{subs}. Valid values for @samp{type} are @qcode{"()"}, +@qcode{"@{@}"}, and @qcode{"."}. The @samp{subs} field may be either +@qcode{":"} or a cell array of index values. + +The following example shows how to set the two first columns of a 3-by-3 +matrix to zero. + +@example +@group +val = magic (3); +idx.type = "()"; +idx.subs = @{":", 1:2@}; +subsasgn (val, idx, 0) + @result{} [ 0 0 6 + 0 0 7 + 0 0 2 ] +@end group +@end example + +Note that this is the same as writing @code{val(:, 1:2) = 0}. + +If @var{idx} is an empty structure array with fields @samp{type} and +@samp{subs}, return @var{rhs}. +@seealso{subsref, substruct, optimize_subsasgn_calls} +@end deftypefn */) { if (args.length () != 3) print_usage (); @@ -2966,11 +2966,11 @@ */ DEFUN (is_sq_string, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} is_sq_string (@var{x})\n\ -Return true if @var{x} is a single-quoted character string.\n\ -@seealso{is_dq_string, ischar}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} is_sq_string (@var{x}) +Return true if @var{x} is a single-quoted character string. +@seealso{is_dq_string, ischar} +@end deftypefn */) { if (args.length () != 1) print_usage (); @@ -2989,11 +2989,11 @@ */ DEFUN (is_dq_string, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} is_dq_string (@var{x})\n\ -Return true if @var{x} is a double-quoted character string.\n\ -@seealso{is_sq_string, ischar}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} is_dq_string (@var{x}) +Return true if @var{x} is a double-quoted character string. +@seealso{is_sq_string, ischar} +@end deftypefn */) { if (args.length () != 1) print_usage (); @@ -3012,21 +3012,21 @@ */ DEFUN (disable_permutation_matrix, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{val} =} disable_permutation_matrix ()\n\ -@deftypefnx {} {@var{old_val} =} disable_permutation_matrix (@var{new_val})\n\ -@deftypefnx {} {} disable_permutation_matrix (@var{new_val}, \"local\")\n\ -Query or set the internal variable that controls whether permutation\n\ -matrices are stored in a special space-efficient format.\n\ -\n\ -The default value is true. If this option is disabled Octave will store\n\ -permutation matrices as full matrices.\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\ -The original variable value is restored when exiting the function.\n\ -@seealso{disable_range, disable_diagonal_matrix}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{val} =} disable_permutation_matrix () +@deftypefnx {} {@var{old_val} =} disable_permutation_matrix (@var{new_val}) +@deftypefnx {} {} disable_permutation_matrix (@var{new_val}, "local") +Query or set the internal variable that controls whether permutation +matrices are stored in a special space-efficient format. + +The default value is true. If this option is disabled Octave will store +permutation matrices as full matrices. + +When called from inside a function with the @qcode{"local"} option, the +variable is changed locally for the function and any subroutines it calls. +The original variable value is restored when exiting the function. +@seealso{disable_range, disable_diagonal_matrix} +@end deftypefn */) { return SET_INTERNAL_VARIABLE (disable_permutation_matrix); } @@ -3042,21 +3042,21 @@ */ DEFUN (disable_diagonal_matrix, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{val} =} disable_diagonal_matrix ()\n\ -@deftypefnx {} {@var{old_val} =} disable_diagonal_matrix (@var{new_val})\n\ -@deftypefnx {} {} disable_diagonal_matrix (@var{new_val}, \"local\")\n\ -Query or set the internal variable that controls whether diagonal\n\ -matrices are stored in a special space-efficient format.\n\ -\n\ -The default value is true. If this option is disabled Octave will store\n\ -diagonal matrices as full matrices.\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\ -The original variable value is restored when exiting the function.\n\ -@seealso{disable_range, disable_permutation_matrix}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{val} =} disable_diagonal_matrix () +@deftypefnx {} {@var{old_val} =} disable_diagonal_matrix (@var{new_val}) +@deftypefnx {} {} disable_diagonal_matrix (@var{new_val}, "local") +Query or set the internal variable that controls whether diagonal +matrices are stored in a special space-efficient format. + +The default value is true. If this option is disabled Octave will store +diagonal matrices as full matrices. + +When called from inside a function with the @qcode{"local"} option, the +variable is changed locally for the function and any subroutines it calls. +The original variable value is restored when exiting the function. +@seealso{disable_range, disable_permutation_matrix} +@end deftypefn */) { return SET_INTERNAL_VARIABLE (disable_diagonal_matrix); } @@ -3086,21 +3086,21 @@ */ DEFUN (disable_range, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{val} =} disable_range ()\n\ -@deftypefnx {} {@var{old_val} =} disable_range (@var{new_val})\n\ -@deftypefnx {} {} disable_range (@var{new_val}, \"local\")\n\ -Query or set the internal variable that controls whether ranges are stored\n\ -in a special space-efficient format.\n\ -\n\ -The default value is true. If this option is disabled Octave will store\n\ -ranges as full matrices.\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\ -The original variable value is restored when exiting the function.\n\ -@seealso{disable_diagonal_matrix, disable_permutation_matrix}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{val} =} disable_range () +@deftypefnx {} {@var{old_val} =} disable_range (@var{new_val}) +@deftypefnx {} {} disable_range (@var{new_val}, "local") +Query or set the internal variable that controls whether ranges are stored +in a special space-efficient format. + +The default value is true. If this option is disabled Octave will store +ranges as full matrices. + +When called from inside a function with the @qcode{"local"} option, the +variable is changed locally for the function and any subroutines it calls. +The original variable value is restored when exiting the function. +@seealso{disable_diagonal_matrix, disable_permutation_matrix} +@end deftypefn */) { return SET_INTERNAL_VARIABLE (disable_range); }