octave-lyh: scripts/help/type.m annotate

annotate scripts/help/type.m @ 17346:1c89599167a6

maint: End m-files with 1 blank line. Simplifies automated grammarchecking script. * scripts/@ftp/ascii.m, scripts/@ftp/binary.m, scripts/@ftp/cd.m, scripts/@ftp/close.m, scripts/@ftp/delete.m, scripts/@ftp/dir.m, scripts/@ftp/display.m, scripts/@ftp/ftp.m, scripts/@ftp/loadobj.m, scripts/@ftp/mget.m, scripts/@ftp/mkdir.m, scripts/@ftp/mput.m, scripts/@ftp/rename.m, scripts/@ftp/rmdir.m, scripts/@ftp/saveobj.m, scripts/audio/lin2mu.m, scripts/audio/loadaudio.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/saveaudio.m, scripts/audio/setaudio.m, scripts/deprecated/__error_text__.m, scripts/deprecated/cut.m, scripts/deprecated/error_text.m, scripts/deprecated/isstr.m, scripts/deprecated/polyderiv.m, scripts/deprecated/studentize.m, scripts/deprecated/sylvester_matrix.m, scripts/general/bicubic.m, scripts/general/celldisp.m, scripts/general/colon.m, scripts/general/cplxpair.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/isdir.m, scripts/general/isequaln.m, scripts/general/loadobj.m, scripts/general/private/__isequal__.m, scripts/general/private/__splinen__.m, scripts/general/profexplore.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/repmat.m, scripts/general/saveobj.m, scripts/geometry/delaunay.m, scripts/help/__unimplemented__.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/print_usage.m, scripts/help/private/__additional_help_message__.m, scripts/help/private/__strip_html_tags__.m, scripts/help/type.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imwrite.m, scripts/image/private/__imfinfo__.m, scripts/image/private/__imread__.m, scripts/image/private/__imwrite__.m, scripts/image/private/imageIO.m, scripts/image/private/imwrite_filename.m, scripts/image/private/ind2x.m, scripts/io/beep.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/subspace.m, scripts/miscellaneous/bug_report.m, scripts/miscellaneous/bunzip2.m, scripts/miscellaneous/cast.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/dump_prefs.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/gunzip.m, scripts/miscellaneous/isdeployed.m, scripts/miscellaneous/ismac.m, scripts/miscellaneous/mex.m, scripts/miscellaneous/mexext.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/namelengthmax.m, scripts/miscellaneous/news.m, scripts/miscellaneous/pack.m, scripts/miscellaneous/perl.m, scripts/miscellaneous/private/display_info_file.m, scripts/miscellaneous/python.m, scripts/miscellaneous/rmappdata.m, scripts/miscellaneous/run.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tempname.m, scripts/miscellaneous/untar.m, scripts/miscellaneous/unzip.m, scripts/miscellaneous/what.m, scripts/miscellaneous/zip.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/optimget.m, scripts/optimization/optimset.m, scripts/optimization/qp.m, scripts/optimization/sqp.m, scripts/path/pathdef.m, scripts/pkg/pkg.m, scripts/pkg/private/build.m, scripts/pkg/private/describe.m, scripts/pkg/private/dirempty.m, scripts/pkg/private/get_forge_download.m, scripts/pkg/private/get_forge_pkg.m, scripts/pkg/private/get_unsatisfied_deps.m, scripts/pkg/private/install.m, scripts/pkg/private/is_architecture_dependent.m, scripts/pkg/private/list_forge_packages.m, scripts/pkg/private/rebuild.m, scripts/pkg/private/shell.m, scripts/pkg/private/uninstall.m, scripts/plot/axes.m, scripts/plot/box.m, scripts/plot/closereq.m, scripts/plot/diffuse.m, scripts/plot/ezpolar.m, scripts/plot/findfigs.m, scripts/plot/gco.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/linkprop.m, scripts/plot/peaks.m, scripts/plot/print.m, scripts/plot/private/__add_datasource__.m, scripts/plot/private/__axis_label__.m, scripts/plot/private/__clabel__.m, scripts/plot/private/__color_str_rgb__.m, scripts/plot/private/__contour__.m, scripts/plot/private/__default_plot_options__.m, scripts/plot/private/__errcomm__.m, scripts/plot/private/__file_filter__.m, scripts/plot/private/__fltk_file_filter__.m, scripts/plot/private/__getlegenddata__.m, scripts/plot/private/__gnuplot_open_stream__.m, scripts/plot/private/__gnuplot_print__.m, scripts/plot/private/__go_draw_axes__.m, scripts/plot/private/__interp_cube__.m, scripts/plot/private/__is_function__.m, scripts/plot/private/__line__.m, scripts/plot/private/__marching_cube__.m, scripts/plot/private/__next_line_style__.m, scripts/plot/private/__patch__.m, scripts/plot/private/__pie__.m, scripts/plot/private/__pltopt__.m, scripts/plot/private/__quiver__.m, scripts/plot/private/__scatter__.m, scripts/plot/private/__stem__.m, scripts/plot/private/__uigetdir_fltk__.m, scripts/plot/private/__uigetfile_fltk__.m, scripts/plot/private/__uiobject_split_args__.m, scripts/plot/private/__uiputfile_fltk__.m, scripts/plot/refresh.m, scripts/plot/saveas.m, scripts/plot/shg.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/uicontextmenu.m, scripts/plot/uicontrol.m, scripts/plot/uipanel.m, scripts/plot/uipushtool.m, scripts/plot/uiresume.m, scripts/plot/uitoggletool.m, scripts/plot/uitoolbar.m, scripts/plot/uiwait.m, scripts/plot/waitforbuttonpress.m, scripts/polynomial/pchip.m, scripts/polynomial/polyeig.m, scripts/polynomial/ppval.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/private/loadprefs.m, scripts/prefs/private/prefsfile.m, scripts/prefs/private/saveprefs.m, scripts/prefs/setpref.m, scripts/set/private/validargs.m, scripts/set/unique.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/arch_test.m, scripts/signal/arma_rnd.m, scripts/signal/durbinlevinson.m, scripts/signal/fractdiff.m, scripts/signal/freqz.m, scripts/signal/freqz_plot.m, scripts/signal/hurst.m, scripts/signal/periodogram.m, scripts/signal/private/rectangle_lw.m, scripts/signal/private/rectangle_sw.m, scripts/signal/private/triangle_sw.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/yulewalker.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/spdiags.m, scripts/sparse/sprandn.m, scripts/specfun/bessel.m, scripts/specfun/betaln.m, scripts/specfun/expint.m, scripts/special-matrix/gallery.m, scripts/startup/__finish__.m, scripts/statistics/base/qqplot.m, scripts/statistics/distributions/tcdf.m, scripts/statistics/distributions/wienrnd.m, scripts/statistics/models/logistic_regression.m, scripts/statistics/models/private/logistic_regression_derivatives.m, scripts/statistics/models/private/logistic_regression_likelihood.m, scripts/statistics/tests/anova.m, scripts/statistics/tests/bartlett_test.m, scripts/statistics/tests/chisquare_test_homogeneity.m, scripts/statistics/tests/chisquare_test_independence.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/f_test_regression.m, scripts/statistics/tests/hotelling_test.m, scripts/statistics/tests/hotelling_test_2.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/manova.m, scripts/statistics/tests/mcnemar_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/run_test.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/strcat.m, scripts/strings/strjoin.m, scripts/strings/strsplit.m, scripts/testfun/__have_feature__.m, scripts/testfun/__printf_assert__.m, scripts/testfun/__prog_output_assert__.m, scripts/testfun/__run_test_suite__.m, scripts/time/clock.m, scripts/time/datenum.m, scripts/ui/errordlg.m, scripts/ui/private/message_dialog.m: End m-files with 1 blank line.

author	Rik <rik@octave.org>
date	Wed, 28 Aug 2013 08:33:02 -0700
parents	f4c8c66faf34
children	a1fa416c7c4a

rev	line source
17251 f4c8c66faf34 maint: Update source file encodings to UTF-8 and fix character errors Mike Miller <mtmiller@ieee.org> parents: 15467 diff changeset	1 ## Copyright (C) 2009-2012 Søren Hauberg
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	2 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	4 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	8 ## your option) any later version.
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	9 ##
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	13 ## General Public License for more details.
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	14 ##
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
11104 2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	17 ## <http://www.gnu.org/licenses/>.
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	18
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	19 ## -- texinfo --
9724 f22bbc5d56e9 Fix various incorrect usages of TeXinfo deffn and deftypefn macros Rik <rdrider0-list@yahoo.com> parents: 9037 diff changeset	20 ## @deftypefn {Command} {} type @var{name} @dots{}
f22bbc5d56e9 Fix various incorrect usages of TeXinfo deffn and deftypefn macros Rik <rdrider0-list@yahoo.com> parents: 9037 diff changeset	21 ## @deftypefnx {Command} {} type -q @var{name} @dots{}
9752 51c21837686f Period spellcheck of Octave documentation to check and fix newly added DOCSTRINGS Rik <rdrider0-list@yahoo.com> parents: 9724 diff changeset	22 ## @deftypefnx {Function File} {dfns =} type ("@var{name}", @dots{})
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	23 ## Display the definition of each @var{name} that refers to a function.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	24 ##
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	25 ## Normally also displays whether each @var{name} is user-defined or built-in;
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 9752 diff changeset	26 ## the @option{-q} option suppresses this behavior.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	27 ##
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	28 ## If an output argument is requested nothing is displayed. Instead, a cell
c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	29 ## array of strings is returned, where each element corresponds to the
9037 4cb9f994dcec Documentation cleanup of var.texi, expr.texi, eval.texi Rik <rdrider0-list@yahoo.com> parents: 8746 diff changeset	30 ## definition of each requested function.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	31 ## @end deftypefn
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	32
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	33 function retval = type (varargin)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	34 ## Parse input
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	35 if (nargin == 0)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	36 error ("type: not enough input arguments");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	37 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	38
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	39 if (!iscellstr (varargin))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	40 error ("type: input arguments must be strings");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	41 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	42
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	43 quiet = false;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	44 idx = strcmpi (varargin, "-q") \| strcmpi (varargin, "-quiet");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	45 if (any (idx))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	46 quiet = true;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	47 varargin (idx) = [];
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	48 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	49
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	50 if (nargout > 0)
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	51 retval = cell (size (varargin));
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	52 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	53
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	54 for n = 1:length (varargin)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	55 name = varargin {n};
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	56
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	57 ## Find function and get its code
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	58 text = "";
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	59 cmd = sprintf ("exist ('%s')", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	60 e = evalin ("caller", cmd);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	61 if (e == 1)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	62 ## Variable
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	63 cmd = sprintf ("disp (%s);", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	64 desc = evalin ("caller", cmd);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	65 if (quiet)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	66 text = desc;
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	67 else
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	68 text = sprintf ("%s is a variable\n%s", name, desc);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	69 endif
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	70 elseif (e == 2)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	71 ## m-file or ordinary file
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	72 file = which (name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	73 if (isempty (file))
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	74 ## 'name' is an ordinary file, and not a function name.
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	75 ## FIXME: Should we just print it anyway?
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	76 error ("type: '%s' undefined\n", name);
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	77 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	78
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	79 ## Read the file
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	80 fid = fopen (file, "r");
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	81 if (fid < 0)
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	82 error ("type: couldn't open '%s' for reading", file);
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	83 endif
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	84 contents = char (fread (fid).');
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	85 fclose (fid);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	86
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	87 if (quiet)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	88 text = contents;
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	89 else
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	90 text = sprintf ("%s is the user-defined function defined from: %s\n\n%s",
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	91 name, file, contents);
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	92 endif
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	93 elseif (e == 3)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	94 text = sprintf ("%s is a dynamically-linked function", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	95 elseif (e == 5)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	96 text = sprintf ("%s is a built-in function", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	97 elseif (any (strcmp (__operators__ (), name)))
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	98 text = sprintf ("%s is an operator", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	99 elseif (any (strcmp (__keywords__ (), name)))
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	100 text = sprintf ("%s is a keyword", name);
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	101 else
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	102 error ("type: '%s' undefined\n", name);
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	103 endif
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	104
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	105 ## Should we return the text or print if
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	106 if (nargout == 0)
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	107 disp (text);
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	108 else
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	109 retval {n} = text;
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	110 endif
92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	111 endfor
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	112 endfunction
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	113
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	114
12838 b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	115 %!test
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	116 %! var = 1;
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	117 %! typestr = type ("var");
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	118 %! typestr = typestr{1}(1:17);
b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	119 %! assert (typestr, "var is a variable");
8582 92d66bbd74af Make 'type X' work when X is a variable sh@sh-t400 parents: 8575 diff changeset	120
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14363 diff changeset	121 %!assert (type ("amd"){1}, "amd is a dynamically-linked function")
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	122 %!assert (type ("cat"){1}, "cat is a built-in function")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123 %!assert (type ("+"){1}, "+ is an operator")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	124 %!assert (type ("end"){1}, "end is a keyword")
12838 b584c07cd818 codesprint: Add tests for type() Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	125 %!error (type ('NO_NAME'))
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	126
17346 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17251 diff changeset	127

Mercurial > hg > octave-lyh

annotate scripts/help/type.m @ 17346:1c89599167a6