# HG changeset patch # User Juan Pablo Carbajal # Date 1353367531 -3600 # Node ID 1407aac91bee6af9de966a28916b505c2fdaeec7 # Parent 534b6f7108b7d593cb0c67bdf789b624654296da error_ids: explanations of standard Octave: erorr ids diff --git a/scripts/miscellaneous/error_ids.m b/scripts/miscellaneous/error_ids.m new file mode 100644 --- /dev/null +++ b/scripts/miscellaneous/error_ids.m @@ -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 +## . + +## -*- 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)