comparison libinterp/octave-value/ov-oncleanup.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
182 182
183 DEFUN (onCleanup, args, , 183 DEFUN (onCleanup, args, ,
184 "-*- texinfo -*-\n\ 184 "-*- texinfo -*-\n\
185 @deftypefn {Built-in Function} {@var{obj} =} onCleanup (@var{function})\n\ 185 @deftypefn {Built-in Function} {@var{obj} =} onCleanup (@var{function})\n\
186 Create a special object that executes a given function upon destruction.\n\ 186 Create a special object that executes a given function upon destruction.\n\
187 \n\
187 If the object is copied to multiple variables (or cell or struct array\n\ 188 If the object is copied to multiple variables (or cell or struct array\n\
188 elements) or returned from a function, @var{function} will be executed after\n\ 189 elements) or returned from a function, @var{function} will be executed after\n\
189 clearing the last copy of the object. Note that if multiple local onCleanup\n\ 190 clearing the last copy of the object. Note that if multiple local onCleanup\n\
190 variables are created, the order in which they are called is unspecified.\n\ 191 variables are created, the order in which they are called is unspecified.\n\
191 For similar functionality @xref{The unwind_protect Statement}.\n\ 192 For similar functionality @xref{The unwind_protect Statement}.\n\