Mercurial > octave-antonio

annotate scripts/miscellaneous/error_ids.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents bf6a909d3d11
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19192
diff changeset
1 ## Copyright (C) 2012-2015 Juan Pablo Carbajal
15703
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
19721
bf6a909d3d11 doc: Use 'nonexistent' rather than 'non-existent' in documentation.
Rik <rik@octave.org>
parents: 19697
diff changeset
37 ## for arrays, nonexistent 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
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19721
diff changeset
43 ## Indicates a call to a function that is not defined. The function may exist
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19721
diff changeset
44 ## but Octave is unable to find it in the search path.
15731
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
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 16816
diff changeset
47 ##
15703
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
19192
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
54 ## Mark file as being tested. No real test needed for a documentation .m file
15703
1407aac91bee error_ids: explanations of standard Octave: erorr ids
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
diff changeset
55 %!assert (1)
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17170
diff changeset
56