changeset 15703:1407aac91bee

error_ids: explanations of standard Octave: erorr ids
author Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
date Tue, 20 Nov 2012 00:25:31 +0100
parents 534b6f7108b7
children c2b381deca6b
files scripts/miscellaneous/error_ids.m
diffstat 1 files changed, 47 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/miscellaneous/error_ids.m	Tue Nov 20 00:25:31 2012 +0100
@@ -0,0 +1,47 @@
+## Copyright (C) 2012 Juan Pablo Carbajal
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @cindex error ids
+##
+## @table @code
+## @item Octave:invalid-context
+## Idicates the error was generated by an operation that cannot be executed in
+## the scope of the call that rose the error. For example, the function
+## @code{print_usage()} when called from ## the Octave prompt rises this error.
+##
+## @item Octave:invalid-input-arg
+## Indicates that a function was called with invalid input arguments.
+##
+## @item Octave:invalid-fun-call
+## Indicates that a function was called in an incorrect way, e.g. wrong number
+## of input arguments.
+##
+## @item Octave:invalid-indexing
+## Indicates that a data-type was indexed incorrectly, e.g. real-value index for
+## arrays, inexistent field of a structure
+##
+## @end table
+
+
+function error_ids ()
+  help ("error_ids");
+endfunction
+
+## Remove from test statistics.  No real tests possible
+%!assert (1)