annotate scripts/miscellaneous/error_ids.m @ 17161:52931d71400f

doc: Document that first argument can be an axes handle for several plot functions. * scripts/plot/feather.m, scripts/plot/hggroup.m, scripts/plot/loglogerr.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m: Document that first argument can be an axes handle for several plot functions.
author Rik <rik@octave.org>
date Fri, 02 Aug 2013 17:37:34 -0700
parents 12005245b645
children d6499c14021c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
1 ## Copyright (C) 2012 Juan Pablo Carbajal
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
2 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
3 ## This file is part of Octave.
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
4 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
8 ## your option) any later version.
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
9 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
13 ## General Public License for more details.
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
14 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
18
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
20 ## @cindex error ids
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
21 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
22 ## @table @code
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
23 ## @item Octave:invalid-context
15705
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
24 ## Indicates the error was generated by an operation that cannot be executed in
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
25 ## the scope from which it was called. For example, the function
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
26 ## @code{print_usage ()} when called from the Octave prompt raises this error.
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
27 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
28 ## @item Octave:invalid-input-arg
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
29 ## Indicates that a function was called with invalid input arguments.
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
30 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
31 ## @item Octave:invalid-fun-call
15705
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
32 ## Indicates that a function was called in an incorrect way, e.g., wrong number
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
33 ## of input arguments.
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
34 ##
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
35 ## @item Octave:invalid-indexing
15705
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
36 ## Indicates that a data-type was indexed incorrectly, e.g., real-value index
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
37 ## for arrays, non-existent field of a structure.
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
38 ##
15731
18f168880226 error_ids: Adding ids and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15705
diff changeset
39 ## @item Octave:bad-alloc
18f168880226 error_ids: Adding ids and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15705
diff changeset
40 ## Indicates that memory couldn't be allocated.
18f168880226 error_ids: Adding ids and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15705
diff changeset
41 ##
18f168880226 error_ids: Adding ids and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15705
diff changeset
42 ## @item Octave:undefined-function
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15731
diff changeset
43 ## Indicates a call to a function that is not defined. The function may
15731
18f168880226 error_ids: Adding ids and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15705
diff changeset
44 ## exist but Octave is unable to find it in the search path.
18f168880226 error_ids: Adding ids and documentation
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15705
diff changeset
45 ##
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
46 ## @end table
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
47
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
48
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
49 function error_ids ()
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
50 help ("error_ids");
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
51 endfunction
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
52
15705
a3189d329906 Update error_ids.m and add it to the build system.
Rik <rik@octave.org>
parents: 15703
diff changeset
53
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
54 ## Remove from test statistics. No real tests possible
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
55 %!assert (1)