Mercurial > octave-antonio
comparison libinterp/dldfcn/__magick_read__.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 | 1f9ed81bd173 |
children |
comparison
equal
deleted
inserted
replaced
20162:2645f9ef8c88 | 20163:075a5e2e1ba5 |
---|---|
722 DEFUN_DLD (__magick_read__, args, nargout, | 722 DEFUN_DLD (__magick_read__, args, nargout, |
723 "-*- texinfo -*-\n\ | 723 "-*- texinfo -*-\n\ |
724 @deftypefn {Loadable Function} {[@var{img}, @var{map}, @var{alpha}] =} __magick_read__ (@var{fname}, @var{options})\n\ | 724 @deftypefn {Loadable Function} {[@var{img}, @var{map}, @var{alpha}] =} __magick_read__ (@var{fname}, @var{options})\n\ |
725 Read image with GraphicsMagick or ImageMagick.\n\ | 725 Read image with GraphicsMagick or ImageMagick.\n\ |
726 \n\ | 726 \n\ |
727 This is a private internal function not intended for direct use. Instead\n\ | 727 This is a private internal function not intended for direct use.\n\ |
728 use @code{imread}.\n\ | 728 Use @code{imread} instead.\n\ |
729 \n\ | 729 \n\ |
730 @seealso{imfinfo, imformats, imread, imwrite}\n\ | 730 @seealso{imfinfo, imformats, imread, imwrite}\n\ |
731 @end deftypefn") | 731 @end deftypefn") |
732 { | 732 { |
733 octave_value_list output; | 733 octave_value_list output; |
1386 DEFUN_DLD (__magick_write__, args, , | 1386 DEFUN_DLD (__magick_write__, args, , |
1387 "-*- texinfo -*-\n\ | 1387 "-*- texinfo -*-\n\ |
1388 @deftypefn {Loadable Function} {} __magick_write__ (@var{fname}, @var{fmt}, @var{img}, @var{map}, @var{options})\n\ | 1388 @deftypefn {Loadable Function} {} __magick_write__ (@var{fname}, @var{fmt}, @var{img}, @var{map}, @var{options})\n\ |
1389 Write image with GraphicsMagick or ImageMagick.\n\ | 1389 Write image with GraphicsMagick or ImageMagick.\n\ |
1390 \n\ | 1390 \n\ |
1391 This is a private internal function not intended for direct use. Instead\n\ | 1391 This is a private internal function not intended for direct use.\n\ |
1392 use @code{imwrite}.\n\ | 1392 Use @code{imwrite} instead.\n\ |
1393 \n\ | 1393 \n\ |
1394 @seealso{imfinfo, imformats, imread, imwrite}\n\ | 1394 @seealso{imfinfo, imformats, imread, imwrite}\n\ |
1395 @end deftypefn") | 1395 @end deftypefn") |
1396 { | 1396 { |
1397 octave_value_list retval; | 1397 octave_value_list retval; |
1787 DEFUN_DLD (__magick_finfo__, args, , | 1787 DEFUN_DLD (__magick_finfo__, args, , |
1788 "-*- texinfo -*-\n\ | 1788 "-*- texinfo -*-\n\ |
1789 @deftypefn {Loadable Function} {} __magick_finfo__ (@var{fname})\n\ | 1789 @deftypefn {Loadable Function} {} __magick_finfo__ (@var{fname})\n\ |
1790 Read image information with GraphicsMagick or ImageMagick.\n\ | 1790 Read image information with GraphicsMagick or ImageMagick.\n\ |
1791 \n\ | 1791 \n\ |
1792 This is a private internal function not intended for direct use. Instead\n\ | 1792 This is a private internal function not intended for direct use.\n\ |
1793 use @code{imfinfo}.\n\ | 1793 Use @code{imfinfo} instead.\n\ |
1794 \n\ | 1794 \n\ |
1795 @seealso{imfinfo, imformats, imread, imwrite}\n\ | 1795 @seealso{imfinfo, imformats, imread, imwrite}\n\ |
1796 @end deftypefn") | 1796 @end deftypefn") |
1797 { | 1797 { |
1798 octave_value retval; | 1798 octave_value retval; |