Mercurial > hg > octave-lyh
diff scripts/startup/__finish__.m @ 8812:7d48766c21a5
use consistent format for doc strings of internal functions
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 19 Feb 2009 02:16:34 -0500 |
parents | 17f2cdb5232e |
children | eb63fbe60fab |
line wrap: on
line diff
--- a/scripts/startup/__finish__.m +++ b/scripts/startup/__finish__.m @@ -18,16 +18,15 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} __finish__ () -## Checks for the existence of the function/script, @file{finish}, in the -## path or current working directory and executes it. This function is -## intended to be excecuted upon a clean exit form Octave. -## -## This functin is intended to be called upon a clean exit from Octave. -## This is accomplished in the system script @file{startup/octaverc} by -## use of the built in function @code{onexit}. -## @seealso{octaverc, onexit} +## Undocumented internal function. ## @end deftypefn +## Check for the existence of the function/script, @file{finish}, in the +## path or current working directory and execute it. This function is +## intended to be excecuted upon a clean exit form Octave. This is +## accomplished in the system script @file{startup/octaverc} by use of +## the built-in function @code{onexit}. + function __finish__ () if (exist ("finish", "file"))