Mercurial > hg > octave-lyh

comparison scripts/help/unimplemented.m @ 15558:8e6a72cac999

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 1f90fc84065a
children
comparison
equal deleted inserted replaced
15557:13206177060b 15558:8e6a72cac999
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} unimplemented () 21 ## @deftypefn {Function File} {@var{txt} =} unimplemented (@var{fcn})
22 ## Undocumented internal function. 22 ## Return specific help text for the unimplemented function @var{fcn}.
23 ## This is usually a suggestion for an existing compatible function to use in
24 ## place of @var{fcn}.
25 ##
26 ## This function is not called by users, but by the Octave interpreter when
27 ## it fails to recognize an input string as a valid function name. See
28 ## @code{missing_function_hook} for using a different handler for this event.
29 ## @seealso{missing_function_hook}
23 ## @end deftypefn 30 ## @end deftypefn
24 31
32
25 function txt = unimplemented (fcn) 33 function txt = unimplemented (fcn)
34
35 if (nargin != 1)
36 print_usage ();
37 endif
26 38
27 is_matlab_function = true; 39 is_matlab_function = true;
28 40
29 ## Some smarter cases, add more as needed. 41 ## Some smarter cases, add more as needed.
30 switch (fcn) 42 switch (fcn)