Mercurial > octave
diff libinterp/corefcn/dlmread.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 | cb0fdd941d84 |
children | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/corefcn/dlmread.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/dlmread.cc Tue Jun 21 16:07:51 2016 -0400 @@ -157,38 +157,38 @@ } DEFUN (dlmread, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{data} =} dlmread (@var{file})\n\ -@deftypefnx {} {@var{data} =} dlmread (@var{file}, @var{sep})\n\ -@deftypefnx {} {@var{data} =} dlmread (@var{file}, @var{sep}, @var{r0}, @var{c0})\n\ -@deftypefnx {} {@var{data} =} dlmread (@var{file}, @var{sep}, @var{range})\n\ -@deftypefnx {} {@var{data} =} dlmread (@dots{}, \"emptyvalue\", @var{EMPTYVAL})\n\ -Read numeric data from the text file @var{file} which uses the delimiter\n\ -@var{sep} between data values.\n\ -\n\ -If @var{sep} is not defined the separator between fields is determined from\n\ -the file itself.\n\ -\n\ -The optional scalar arguments @var{r0} and @var{c0} define the starting row\n\ -and column of the data to be read. These values are indexed from zero,\n\ -i.e., the first data row corresponds to an index of zero.\n\ -\n\ -The @var{range} parameter specifies exactly which data elements are read.\n\ -The first form of the parameter is a 4-element vector containing the upper\n\ -left and lower right corners @code{[@var{R0},@var{C0},@var{R1},@var{C1}]}\n\ -where the indices are zero-based. Alternatively, a spreadsheet style\n\ -form such as @qcode{\"A2..Q15\"} or @qcode{\"T1:AA5\"} can be used. The\n\ -lowest alphabetical index @qcode{'A'} refers to the first column. The\n\ -lowest row index is 1.\n\ -\n\ -@var{file} should be a filename or a file id given by @code{fopen}. In the\n\ -latter case, the file is read until end of file is reached.\n\ -\n\ -The @qcode{\"emptyvalue\"} option may be used to specify the value used to\n\ -fill empty fields. The default is zero. Note that any non-numeric values,\n\ -such as text, are also replaced by the @qcode{\"emptyvalue\"}.\n\ -@seealso{csvread, textscan, textread, dlmwrite}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{data} =} dlmread (@var{file}) +@deftypefnx {} {@var{data} =} dlmread (@var{file}, @var{sep}) +@deftypefnx {} {@var{data} =} dlmread (@var{file}, @var{sep}, @var{r0}, @var{c0}) +@deftypefnx {} {@var{data} =} dlmread (@var{file}, @var{sep}, @var{range}) +@deftypefnx {} {@var{data} =} dlmread (@dots{}, "emptyvalue", @var{EMPTYVAL}) +Read numeric data from the text file @var{file} which uses the delimiter +@var{sep} between data values. + +If @var{sep} is not defined the separator between fields is determined from +the file itself. + +The optional scalar arguments @var{r0} and @var{c0} define the starting row +and column of the data to be read. These values are indexed from zero, +i.e., the first data row corresponds to an index of zero. + +The @var{range} parameter specifies exactly which data elements are read. +The first form of the parameter is a 4-element vector containing the upper +left and lower right corners @code{[@var{R0},@var{C0},@var{R1},@var{C1}]} +where the indices are zero-based. Alternatively, a spreadsheet style +form such as @qcode{"A2..Q15"} or @qcode{"T1:AA5"} can be used. The +lowest alphabetical index @qcode{'A'} refers to the first column. The +lowest row index is 1. + +@var{file} should be a filename or a file id given by @code{fopen}. In the +latter case, the file is read until end of file is reached. + +The @qcode{"emptyvalue"} option may be used to specify the value used to +fill empty fields. The default is zero. Note that any non-numeric values, +such as text, are also replaced by the @qcode{"emptyvalue"}. +@seealso{csvread, textscan, textread, dlmwrite} +@end deftypefn */) { int nargin = args.length ();