Mercurial > octave-nkf
changeset 15038:ab18578c2ade
doc: Update docstrings for built-in functions to not use "Loadable Function" as type.
* data.cc, debug.cc, help.cc, ov-oncleanup.cc, sparse.cc: Update docstrings
for built-in functions to use "Built-in Function" as type.
| author | Rik <rik@octave.org> |
|---|---|
| date | Fri, 27 Jul 2012 14:37:37 -0700 |
| parents | 1116864ee270 |
| children | e753177cde93 |
| files | src/data.cc src/debug.cc src/help.cc src/ov-oncleanup.cc src/sparse.cc |
| diffstat | 5 files changed, 38 insertions(+), 38 deletions(-) [+] |
line wrap: on
line diff
--- a/src/data.cc Fri Jul 27 09:11:49 2012 -0700 +++ b/src/data.cc Fri Jul 27 14:37:37 2012 -0700 @@ -5066,7 +5066,7 @@ DEFUN (full, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{FM} =} full (@var{SM})\n\ +@deftypefn {Built-in Function} {@var{FM} =} full (@var{SM})\n\ Return a full storage matrix from a sparse, diagonal, permutation matrix\n\ or a range.\n\ @seealso{sparse}\n\ @@ -5865,10 +5865,10 @@ DEFUN (sort, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\ -@deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\ -@deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\ -@deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\ +@deftypefn {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\ +@deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\ +@deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\ +@deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\ Return a copy of @var{x} with the elements arranged in increasing\n\ order. For matrices, @code{sort} orders the elements within columns\n\ \n\
--- a/src/debug.cc Fri Jul 27 09:11:49 2012 -0700 +++ b/src/debug.cc Fri Jul 27 14:37:37 2012 -0700 @@ -504,8 +504,8 @@ DEFUN (dbstop, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{rline} =} dbstop (\"@var{func}\")\n\ -@deftypefnx {Loadable Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line}, @dots{})\n\ +@deftypefn {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\")\n\ +@deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line}, @dots{})\n\ Set a breakpoint in function @var{func}.\n\ \n\ Arguments are\n\ @@ -548,8 +548,8 @@ DEFUN (dbclear, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbclear (\"@var{func}\")\n\ -@deftypefnx {Loadable Function} {} dbclear (\"@var{func}\", @var{line}, @dots{})\n\ +@deftypefn {Built-in Function} {} dbclear (\"@var{func}\")\n\ +@deftypefnx {Built-in Function} {} dbclear (\"@var{func}\", @var{line}, @dots{})\n\ Delete a breakpoint in the function @var{func}.\n\ \n\ Arguments are\n\ @@ -585,9 +585,9 @@ DEFUN (dbstatus, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbstatus ()\n\ -@deftypefnx {Loadable Function} {@var{brk_list} =} dbstatus ()\n\ -@deftypefnx {Loadable Function} {@var{brk_list} =} dbstatus (\"@var{func}\")\n\ +@deftypefn {Built-in Function} {} dbstatus ()\n\ +@deftypefnx {Built-in Function} {@var{brk_list} =} dbstatus ()\n\ +@deftypefnx {Built-in Function} {@var{brk_list} =} dbstatus (\"@var{func}\")\n\ Report the location of active breakpoints.\n\ \n\ When called with no input or output arguments, print the list of\n\ @@ -701,7 +701,7 @@ DEFUN (dbwhere, , , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbwhere ()\n\ +@deftypefn {Built-in Function} {} dbwhere ()\n\ In debugging mode, report the current file and line number where\n\ execution is stopped.\n\ @seealso{dbstatus, dbcont, dbstep, dbup}\n\ @@ -794,13 +794,13 @@ DEFUN (dbtype, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbtype ()\n\ -@deftypefnx {Loadable Function} {} dbtype (\"startl:endl\")\n\ -@deftypefnx {Loadable Function} {} dbtype (\"startl:end\")\n\ -@deftypefnx {Loadable Function} {} dbtype (\"@var{func}\")\n\ -@deftypefnx {Loadable Function} {} dbtype (\"@var{func}\", \"startl\")\n\ -@deftypefnx {Loadable Function} {} dbtype (\"@var{func}\", \"startl:endl\")\n\ -@deftypefnx {Loadable Function} {} dbtype (\"@var{func}\", \"startl:end\")\n\ +@deftypefn {Built-in Function} {} dbtype ()\n\ +@deftypefnx {Built-in Function} {} dbtype (\"startl:endl\")\n\ +@deftypefnx {Built-in Function} {} dbtype (\"startl:end\")\n\ +@deftypefnx {Built-in Function} {} dbtype (\"@var{func}\")\n\ +@deftypefnx {Built-in Function} {} dbtype (\"@var{func}\", \"startl\")\n\ +@deftypefnx {Built-in Function} {} dbtype (\"@var{func}\", \"startl:endl\")\n\ +@deftypefnx {Built-in Function} {} dbtype (\"@var{func}\", \"startl:end\")\n\ When in debugging mode and called with no arguments, list the script file\n\ being debugged with line numbers. An optional range specification,\n\ specified as a string, can be used to list only a portion of the file.\n\ @@ -1022,9 +1022,9 @@ DEFUN (dbstack, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbstack ()\n\ -@deftypefnx {Loadable Function} {} dbstack (@var{n})\n\ -@deftypefnx {Loadable Function} {[@var{stack}, @var{idx}] =} dbstack (@dots{})\n\ +@deftypefn {Built-in Function} {} dbstack ()\n\ +@deftypefnx {Built-in Function} {} dbstack (@var{n})\n\ +@deftypefnx {Built-in Function} {[@var{stack}, @var{idx}] =} dbstack (@dots{})\n\ Display or return current debugging function stack information.\n\ With optional argument @var{n}, omit the @var{n} innermost stack frames.\n\ \n\ @@ -1090,8 +1090,8 @@ DEFUN (dbup, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbup\n\ -@deftypefnx {Loadable Function} {} dbup (@var{n})\n\ +@deftypefn {Built-in Function} {} dbup\n\ +@deftypefnx {Built-in Function} {} dbup (@var{n})\n\ In debugging mode, move up the execution stack @var{n} frames.\n\ If @var{n} is omitted, move up one frame.\n\ @seealso{dbstack, dbdown}\n\ @@ -1106,8 +1106,8 @@ DEFUN (dbdown, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} dbdown\n\ -@deftypefnx {Loadable Function} {} dbdown (@var{n})\n\ +@deftypefn {Built-in Function} {} dbdown\n\ +@deftypefnx {Built-in Function} {} dbdown (@var{n})\n\ In debugging mode, move down the execution stack @var{n} frames.\n\ If @var{n} is omitted, move down one frame.\n\ @seealso{dbstack, dbup}\n\ @@ -1252,7 +1252,7 @@ DEFUN (isdebugmode, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} isdebugmode ()\n\ +@deftypefn {Built-in Function} {} isdebugmode ()\n\ Return true if in debugging mode, otherwise false.\n\ @seealso{dbwhere, dbstack, dbstatus}\n\ @end deftypefn")
--- a/src/help.cc Fri Jul 27 09:11:49 2012 -0700 +++ b/src/help.cc Fri Jul 27 14:37:37 2012 -0700 @@ -954,7 +954,7 @@ } DEFUN (get_help_text, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\ +@deftypefn {Built-in Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\ Return the raw help text of function @var{name}.\n\ \n\ The raw help text is returned in @var{text} and the format in @var{format}\n\ @@ -1023,7 +1023,7 @@ DEFUN (get_help_text_from_file, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\ +@deftypefn {Built-in Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\ Return the raw help text from the file @var{fname}.\n\ \n\ The raw help text is returned in @var{text} and the format in @var{format}\n\
--- a/src/ov-oncleanup.cc Fri Jul 27 09:11:49 2012 -0700 +++ b/src/ov-oncleanup.cc Fri Jul 27 14:37:37 2012 -0700 @@ -191,7 +191,7 @@ DEFUN (onCleanup, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{c} =} onCleanup (@var{action})\n\ +@deftypefn {Built-in Function} {@var{c} =} onCleanup (@var{action})\n\ Create a special object that executes a given function upon destruction.\n\ If the object is copied to multiple variables (or cell or struct array\n\ elements) or returned from a function, @var{action} will be executed after\n\
--- a/src/sparse.cc Fri Jul 27 09:11:49 2012 -0700 +++ b/src/sparse.cc Fri Jul 27 14:37:37 2012 -0700 @@ -43,7 +43,7 @@ DEFUN (issparse, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {} issparse (@var{x})\n\ +@deftypefn {Built-in Function} {} issparse (@var{x})\n\ Return true if @var{x} is a sparse matrix.\n\ @seealso{ismatrix}\n\ @end deftypefn") @@ -59,11 +59,11 @@ DEFUN (sparse, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{s} =} sparse (@var{a})\n\ -@deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\ -@deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\ -@deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\ -@deftypefnx {Loadable Function} {@var{s} =} sparse (@var{m}, @var{n})\n\ +@deftypefn {Built-in Function} {@var{s} =} sparse (@var{a})\n\ +@deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\ +@deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\ +@deftypefnx {Built-in Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\ +@deftypefnx {Built-in Function} {@var{s} =} sparse (@var{m}, @var{n})\n\ Create a sparse matrix from the full matrix or row, column, value triplets.\n\ If @var{a} is a full matrix, convert it to a sparse matrix representation,\n\ removing all zero values in the process.\n\ @@ -209,7 +209,7 @@ DEFUN (spalloc, args, , "-*- texinfo -*-\n\ -@deftypefn {Loadable Function} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})\n\ +@deftypefn {Built-in Function} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})\n\ Create an @var{m}-by-@var{n} sparse matrix with pre-allocated space for at\n\ most @var{nz} nonzero elements. This is useful for building the matrix\n\ incrementally by a sequence of indexed assignments. Subsequent indexed\n\