Mercurial > octave-antonio
comparison libinterp/dldfcn/convhulln.cc @ 20163:075a5e2e1ba5 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value,
libinterp/parse-tree directories.
* build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc,
libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc,
libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll,
libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc:
doc: Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 21:52:42 -0700 |
| parents | 4197fc428c7d |
| children |
comparison
equal
deleted
inserted
replaced
| 20162:2645f9ef8c88 | 20163:075a5e2e1ba5 |
|---|---|
| 75 DEFUN_DLD (convhulln, args, nargout, | 75 DEFUN_DLD (convhulln, args, nargout, |
| 76 "-*- texinfo -*-\n\ | 76 "-*- texinfo -*-\n\ |
| 77 @deftypefn {Loadable Function} {@var{h} =} convhulln (@var{pts})\n\ | 77 @deftypefn {Loadable Function} {@var{h} =} convhulln (@var{pts})\n\ |
| 78 @deftypefnx {Loadable Function} {@var{h} =} convhulln (@var{pts}, @var{options})\n\ | 78 @deftypefnx {Loadable Function} {@var{h} =} convhulln (@var{pts}, @var{options})\n\ |
| 79 @deftypefnx {Loadable Function} {[@var{h}, @var{v}] =} convhulln (@dots{})\n\ | 79 @deftypefnx {Loadable Function} {[@var{h}, @var{v}] =} convhulln (@dots{})\n\ |
| 80 Compute the convex hull of the set of points @var{pts} which is a matrix\n\ | 80 Compute the convex hull of the set of points @var{pts}.\n\ |
| 81 of size [n, dim] containing n points in a space of dimension dim.\n\ | 81 \n\ |
| 82 @var{pts} is a matrix of size [n, dim] containing n points in a space of\n\ | |
| 83 dimension dim.\n\ | |
| 84 \n\ | |
| 82 The hull @var{h} is an index vector into the set of points and specifies\n\ | 85 The hull @var{h} is an index vector into the set of points and specifies\n\ |
| 83 which points form the enclosing hull.\n\ | 86 which points form the enclosing hull.\n\ |
| 84 \n\ | 87 \n\ |
| 85 An optional second argument, which must be a string or cell array of strings,\n\ | 88 An optional second argument, which must be a string or cell array of strings,\n\ |
| 86 contains options passed to the underlying qhull command.\n\ | 89 contains options passed to the underlying qhull command.\n\ |