Mercurial > octave
diff libinterp/corefcn/symtab.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 | b571fc85953f |
children | 03c692adf563 |
line wrap: on
line diff
--- a/libinterp/corefcn/symtab.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/symtab.cc Tue Jun 21 16:07:51 2016 -0400 @@ -1687,23 +1687,23 @@ } DEFUN (ignore_function_time_stamp, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{val} =} ignore_function_time_stamp ()\n\ -@deftypefnx {} {@var{old_val} =} ignore_function_time_stamp (@var{new_val})\n\ -Query or set the internal variable that controls whether Octave checks\n\ -the time stamp on files each time it looks up functions defined in\n\ -function files.\n\ -\n\ -If the internal variable is set to @qcode{\"system\"}, Octave will not\n\ -automatically recompile function files in subdirectories of\n\ -@file{@var{octave-home}/lib/@var{version}} if they have changed since they were last compiled, but will recompile other function files in the search path if they change.\n\ -\n\ -If set to @qcode{\"all\"}, Octave will not recompile any function files\n\ -unless their definitions are removed with @code{clear}.\n\ -\n\ -If set to @qcode{\"none\"}, Octave will always check time stamps on files to\n\ -determine whether functions defined in function files need to recompiled.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{val} =} ignore_function_time_stamp () +@deftypefnx {} {@var{old_val} =} ignore_function_time_stamp (@var{new_val}) +Query or set the internal variable that controls whether Octave checks +the time stamp on files each time it looks up functions defined in +function files. + +If the internal variable is set to @qcode{"system"}, Octave will not +automatically recompile function files in subdirectories of +@file{@var{octave-home}/lib/@var{version}} if they have changed since they were last compiled, but will recompile other function files in the search path if they change. + +If set to @qcode{"all"}, Octave will not recompile any function files +unless their definitions are removed with @code{clear}. + +If set to @qcode{"none"}, Octave will always check time stamps on files to +determine whether functions defined in function files need to recompiled. +@end deftypefn */) { int nargin = args.length (); @@ -1766,24 +1766,24 @@ */ DEFUN (__current_scope__, , , - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{scope}, @var{context}]} __current_scope__ ()\n\ -Return the current scope and context as integers.\n\ -@seealso{__dump_symtab_info__}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{scope}, @var{context}]} __current_scope__ () +Return the current scope and context as integers. +@seealso{__dump_symtab_info__} +@end deftypefn */) { return ovl (symbol_table::current_scope (), symbol_table::current_context ()); } DEFUN (__dump_symtab_info__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __dump_symtab_info__ ()\n\ -@deftypefnx {} {} __dump_symtab_info__ (@var{scope})\n\ -@deftypefnx {} {} __dump_symtab_info__ (\"scopes\")\n\ -@deftypefnx {} {} __dump_symtab_info__ (\"functions\")\n\ -Undocumented internal function.\n\ -@seealso{__current_scope__}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} __dump_symtab_info__ () +@deftypefnx {} {} __dump_symtab_info__ (@var{scope}) +@deftypefnx {} {} __dump_symtab_info__ ("scopes") +@deftypefnx {} {} __dump_symtab_info__ ("functions") +Undocumented internal function. +@seealso{__current_scope__} +@end deftypefn */) { int nargin = args.length (); @@ -1845,10 +1845,10 @@ } DEFUN (__get_cmdline_fcn_txt__, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {} __get_cmdline_fcn_txt__ (@var{name})\n\ -Undocumented internal function.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {} __get_cmdline_fcn_txt__ (@var{name}) +Undocumented internal function. +@end deftypefn */) { if (args.length () != 1) print_usage (); @@ -1875,41 +1875,37 @@ return retval; } -#if 0 - // FIXME: should we have functions like this in Octave? - -DEFUN (set_variable, args, , "set_variable (NAME, VALUE)") -{ - if (args.length () != 2) - print_usage (); - - std::string name = args(0).xstring_value ("set_variable: variable NAME must be a string"); - - symbol_table::assign (name, args(1)); - - return ovl (); -} - -DEFUN (variable_value, args, , "VALUE = variable_value (NAME)") -{ - if (args.length () != 1) - print_usage (); - - octave_value retval; - - std::string name = args(0).xstring_value ("variable_value: variable NAME must be a string"); - - retval = symbol_table::varval (name); - - if (retval.is_undefined ()) - error ("variable_value: '%s' is not a variable in the current scope", - name.c_str ()); - - return retval; -} -#endif - +// +// DEFUN (set_variable, args, , "set_variable (NAME, VALUE)") +// { +// if (args.length () != 2) +// print_usage (); +// +// std::string name = args(0).xstring_value ("set_variable: variable NAME must be a string"); +// +// symbol_table::assign (name, args(1)); +// +// return ovl (); +// } +// +// DEFUN (variable_value, args, , "VALUE = variable_value (NAME)") +// { +// if (args.length () != 1) +// print_usage (); +// +// octave_value retval; +// +// std::string name = args(0).xstring_value ("variable_value: variable NAME must be a string"); +// +// retval = symbol_table::varval (name); +// +// if (retval.is_undefined ()) +// error ("variable_value: '%s' is not a variable in the current scope", +// name.c_str ()); +// +// return retval; +// } /* bug #34497: 'clear -f' does not work for command line functions