Mercurial > hg > octave-avbm
comparison src/data.cc @ 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 | abc858bc5165 |
comparison
equal
deleted
inserted
replaced
15034:1116864ee270 | 15038:ab18578c2ade |
---|---|
5064 return retval; | 5064 return retval; |
5065 } | 5065 } |
5066 | 5066 |
5067 DEFUN (full, args, , | 5067 DEFUN (full, args, , |
5068 "-*- texinfo -*-\n\ | 5068 "-*- texinfo -*-\n\ |
5069 @deftypefn {Loadable Function} {@var{FM} =} full (@var{SM})\n\ | 5069 @deftypefn {Built-in Function} {@var{FM} =} full (@var{SM})\n\ |
5070 Return a full storage matrix from a sparse, diagonal, permutation matrix\n\ | 5070 Return a full storage matrix from a sparse, diagonal, permutation matrix\n\ |
5071 or a range.\n\ | 5071 or a range.\n\ |
5072 @seealso{sparse}\n\ | 5072 @seealso{sparse}\n\ |
5073 @end deftypefn") | 5073 @end deftypefn") |
5074 { | 5074 { |
5863 return retval; | 5863 return retval; |
5864 } | 5864 } |
5865 | 5865 |
5866 DEFUN (sort, args, nargout, | 5866 DEFUN (sort, args, nargout, |
5867 "-*- texinfo -*-\n\ | 5867 "-*- texinfo -*-\n\ |
5868 @deftypefn {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\ | 5868 @deftypefn {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x})\n\ |
5869 @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\ | 5869 @deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim})\n\ |
5870 @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\ | 5870 @deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{mode})\n\ |
5871 @deftypefnx {Loadable Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\ | 5871 @deftypefnx {Built-in Function} {[@var{s}, @var{i}] =} sort (@var{x}, @var{dim}, @var{mode})\n\ |
5872 Return a copy of @var{x} with the elements arranged in increasing\n\ | 5872 Return a copy of @var{x} with the elements arranged in increasing\n\ |
5873 order. For matrices, @code{sort} orders the elements within columns\n\ | 5873 order. For matrices, @code{sort} orders the elements within columns\n\ |
5874 \n\ | 5874 \n\ |
5875 For example:\n\ | 5875 For example:\n\ |
5876 \n\ | 5876 \n\ |