Mercurial > hg > octave-nkf
changeset 15558:8e6a72cac999
unimplemented.m: Add docstring for internal function.
* unimplemented.m: Add docstring for internal function.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 24 Oct 2012 10:46:06 -0700 |
parents | 13206177060b |
children | 6f3363ff368c |
files | scripts/help/unimplemented.m |
diffstat | 1 files changed, 14 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/help/unimplemented.m +++ b/scripts/help/unimplemented.m @@ -18,12 +18,24 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} unimplemented () -## Undocumented internal function. +## @deftypefn {Function File} {@var{txt} =} unimplemented (@var{fcn}) +## Return specific help text for the unimplemented function @var{fcn}. +## This is usually a suggestion for an existing compatible function to use in +## place of @var{fcn}. +## +## This function is not called by users, but by the Octave interpreter when +## it fails to recognize an input string as a valid function name. See +## @code{missing_function_hook} for using a different handler for this event. +## @seealso{missing_function_hook} ## @end deftypefn + function txt = unimplemented (fcn) + if (nargin != 1) + print_usage (); + endif + is_matlab_function = true; ## Some smarter cases, add more as needed.