comparison libinterp/octave-value/ov-bool-mat.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 09ed6f7538dd
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
559 DEFUN (logical, args, , 559 DEFUN (logical, args, ,
560 "-*- texinfo -*-\n\ 560 "-*- texinfo -*-\n\
561 @deftypefn {Built-in Function} {} logical (@var{x})\n\ 561 @deftypefn {Built-in Function} {} logical (@var{x})\n\
562 Convert the numeric object @var{x} to logical type.\n\ 562 Convert the numeric object @var{x} to logical type.\n\
563 \n\ 563 \n\
564 Any nonzero values will be converted to true (1) while zero values\n\ 564 Any nonzero values will be converted to true (1) while zero values will be\n\
565 will be converted to false (0). The non-numeric value NaN cannot be\n\ 565 converted to false (0). The non-numeric value NaN cannot be converted and\n\
566 converted and will produce an error.\n\ 566 will produce an error.\n\
567 \n\ 567 \n\
568 Compatibility Note: Octave accepts complex values as input, whereas\n\ 568 Compatibility Note: Octave accepts complex values as input, whereas\n\
569 @sc{matlab} issues an error.\n\ 569 @sc{matlab} issues an error.\n\
570 @seealso{double, single, char}\n\ 570 @seealso{double, single, char}\n\
571 @end deftypefn") 571 @end deftypefn")