comparison libinterp/octave-value/ov-null-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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
95 95
96 DEFUN (isnull, args, , 96 DEFUN (isnull, args, ,
97 "-*- texinfo -*-\n\ 97 "-*- texinfo -*-\n\
98 @deftypefn {Built-in Function} {} isnull (@var{x})\n\ 98 @deftypefn {Built-in Function} {} isnull (@var{x})\n\
99 Return true if @var{x} is a special null matrix, string, or single quoted\n\ 99 Return true if @var{x} is a special null matrix, string, or single quoted\n\
100 string. Indexed assignment with such a value on the right-hand side should\n\ 100 string.\n\
101 delete array elements. This function should be used when overloading\n\ 101 \n\
102 indexed assignment for user-defined classes instead of @code{isempty}, to\n\ 102 Indexed assignment with such a value on the right-hand side should delete\n\
103 array elements. This function should be used when overloading indexed\n\
104 assignment for user-defined classes instead of @code{isempty}, to\n\
103 distinguish the cases:\n\ 105 distinguish the cases:\n\
104 \n\ 106 \n\
105 @table @asis\n\ 107 @table @asis\n\
106 @item @code{A(I) = []}\n\ 108 @item @code{A(I) = []}\n\
107 This should delete elements if @code{I} is nonempty.\n\ 109 This should delete elements if @code{I} is nonempty.\n\