Mercurial > octave-antonio
annotate scripts/io/beep.m @ 20160:03b9d17a2d95 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed io, java, linear-algebra, prefs, and set script directories.
* scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m,
scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m,
scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m,
scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m,
scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m,
scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m,
scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m,
scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m,
scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m,
scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m,
scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m,
scripts/set/powerset.m, scripts/set/setdiff.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 15:36:23 -0700 |
parents | 4197fc428c7d |
children |
rev | line source |
---|---|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 2003-2015 John W. Eaton |
4263 | 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 | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
4263 | 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 | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
4263 | 18 |
19 ## -*- texinfo -*- | |
6567 | 20 ## @deftypefn {Function File} {} beep () |
4293 | 21 ## Produce a beep from the speaker (or visual bell). |
20160
03b9d17a2d95
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
22 ## |
03b9d17a2d95
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 ## This function sends the alarm character @qcode{"\a"} to the terminal. |
03b9d17a2d95
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
24 ## Depending on the user's configuration this may produce an audible beep, |
03b9d17a2d95
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
25 ## a visual bell, or nothing at all. |
5642 | 26 ## @seealso{puts, fputs, printf, fprintf} |
4263 | 27 ## @end deftypefn |
28 | |
29 ## Author: jwe | |
30 | |
31 function beep () | |
32 | |
13041
e5a49b2f8225
codesprint: Single input validation test for beep.m
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
33 if (nargin != 0) |
6046 | 34 print_usage (); |
4268 | 35 endif |
4263 | 36 |
13041
e5a49b2f8225
codesprint: Single input validation test for beep.m
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
37 puts ("\a"); |
e5a49b2f8225
codesprint: Single input validation test for beep.m
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
38 |
4263 | 39 endfunction |
13041
e5a49b2f8225
codesprint: Single input validation test for beep.m
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
40 |
e5a49b2f8225
codesprint: Single input validation test for beep.m
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
41 |
e5a49b2f8225
codesprint: Single input validation test for beep.m
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
42 %!error (beep (1)) |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
43 |