Mercurial > hg > octave-lyh
annotate scripts/startup/__finish__.m @ 14611:f2ed09ae8d3f
doc: Produce .texi from .txi files using Perl rather than C++.
* munge-texi.pl: New Perl file to generate .texi files from .txi files.
* munge-texi.cc: Remove C++ file for generating .texi files.
* Makefile.am: Change build system to use munge-texi.pl
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 08 May 2012 21:03:42 -0700 |
parents | f3d52523cde1 |
children | 1c89599167a6 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
12839
diff
changeset
|
1 ## Copyright (C) 2008-2012 Ben Abbott |
7388 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7 ## the Free Software Foundation; either version 3 of the License, or (at | |
8 ## your option) any later version. | |
9 ## | |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
16 ## along with Octave; see the file COPYING. If not, see | |
17 ## <http://www.gnu.org/licenses/>. | |
18 | |
19 ## -*- texinfo -*- | |
20 ## @deftypefn {Function File} {} __finish__ () | |
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7392
diff
changeset
|
21 ## Undocumented internal function. |
7388 | 22 ## @end deftypefn |
23 | |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
24 ## Check for the existence of the function/script, @file{finish}, in the |
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7392
diff
changeset
|
25 ## path or current working directory and execute it. This function is |
14218
bed72845115f
__finish__.m: Clarify internal documentation.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
26 ## intended to be excecuted upon a clean exit from Octave. This is |
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7392
diff
changeset
|
27 ## accomplished in the system script @file{startup/octaverc} by use of |
14218
bed72845115f
__finish__.m: Clarify internal documentation.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
28 ## the built-in function @code{atexit}. |
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7392
diff
changeset
|
29 |
7388 | 30 function __finish__ () |
31 | |
7392 | 32 if (exist ("finish", "file")) |
7388 | 33 ## No arg list here since finish might be a script. |
34 finish; | |
35 endif | |
36 | |
37 endfunction | |
38 | |
14218
bed72845115f
__finish__.m: Clarify internal documentation.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
39 |
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14218
diff
changeset
|
40 |
12839
a2c81af1992d
codesprint: add assert(1) test for __finish__.
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
41 ## No test needed for internal helper function. |
a2c81af1992d
codesprint: add assert(1) test for __finish__.
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
42 %!assert (1) |