octave: scripts/help/which.m annotate

annotate scripts/help/which.m @ 20158:7503499a252b stable

doc: Update docstrings to have one sentence summary as first line. Update scripts in audio, elfun, general, geometry, and image directories. * scripts/audio/@audioplayer/__get_properties__.m, scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m, scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m, scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m, scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m, scripts/audio/@audiorecorder/audiorecorder.m, scripts/audio/@audiorecorder/get.m, scripts/audio/@audiorecorder/getaudiodata.m, scripts/audio/@audiorecorder/getplayer.m, scripts/audio/@audiorecorder/isrecording.m, scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m, scripts/audio/@audiorecorder/recordblocking.m, scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m, scripts/audio/@audiorecorder/subsasgn.m, scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m, scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m, scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m, scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m, scripts/general/accumarray.m, scripts/general/accumdim.m, scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m, scripts/general/blkdiag.m, scripts/general/cart2pol.m, scripts/general/cart2sph.m, scripts/general/cell2mat.m, scripts/general/celldisp.m, scripts/general/chop.m, scripts/general/circshift.m, scripts/general/common_size.m, scripts/general/cplxpair.m, scripts/general/cumtrapz.m, scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m, scripts/general/display.m, scripts/general/divergence.m, scripts/general/fieldnames.m, scripts/general/flip.m, scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m, scripts/general/gradient.m, scripts/general/interp3.m, scripts/general/interpft.m, scripts/general/interpn.m, scripts/general/loadobj.m, scripts/general/logspace.m, scripts/general/methods.m, scripts/general/nargchk.m, scripts/general/narginchk.m, scripts/general/nargoutchk.m, scripts/general/nextpow2.m, scripts/general/nthargout.m, scripts/general/num2str.m, scripts/general/pol2cart.m, scripts/general/polyarea.m, scripts/general/postpad.m, scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m, scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m, scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m, scripts/general/shiftdim.m, scripts/general/sortrows.m, scripts/general/sph2cart.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/trapz.m, scripts/general/triplequad.m, scripts/geometry/delaunayn.m, scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m, scripts/geometry/rectint.m, scripts/geometry/tsearchn.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/help/__unimplemented__.m, scripts/help/doc.m, scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m, scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m, scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m, scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m, scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m, scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m, scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m, scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m, scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m, scripts/image/white.m, scripts/image/winter.m: Update docstrings to have one sentence summary as first line. Re-structure to have line lengths <= 80 chars.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 09:36:20 -0700
parents	4197fc428c7d
children	516bb87ea72e

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 18451 diff changeset	1 ## Copyright (C) 2009-2015 John W. Eaton
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: 10549 diff changeset	3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 diff changeset	4 ##
2c356a35d7f5 fix copyright notices John W. Eaton <jwe@octave.org> parents: 10549 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: 10549 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: 10549 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 --
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Command} {} which name @dots{}
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	21 ## Display the type of each @var{name}.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ## If @var{name} is defined from a function file, the full name of the file is
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## also displayed.
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	25 ## @seealso{help, lookfor}
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	26 ## @end deftypefn
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	27
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	28 function varargout = which (varargin)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	29
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	30 if (nargin > 0 && iscellstr (varargin))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	31 m = __which__ (varargin{:});
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	32
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	33 ## Check whether each name is a variable, variables take precedence over
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	34 ## functions in name resolution.
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	35 for i = 1:nargin
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	36 m(i).is_variable = evalin ("caller",
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	37 ["exist (\"" m(i).name "\", \"var\")"], false);
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	38 if (m(i).is_variable)
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	39 m(i).file = "variable";
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	40 endif
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	41 endfor
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	42
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	43 if (nargout == 0)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	44 for i = 1:nargin
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	45 if (m(i).is_variable)
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	46 printf ("'%s' is a variable\n", m(i).name);
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	47 elseif (isempty (m(i).file))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	48 if (! isempty (m(i).type))
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	49 printf ("'%s' is a %s\n",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	50 m(i).name, m(i).type);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	51 endif
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	52 else
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	53 if (isempty (m(i).type))
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	54 printf ("'%s' is the file %s\n",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	55 m(i).name, m(i).file);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	56 else
15466 d174210ce1ec use ' instead of ` in error messages, warnings and most comments John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	57 printf ("'%s' is a %s from the file %s\n",
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	58 m(i).name, m(i).type, m(i).file);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	59 endif
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 8761 diff changeset	60 endif
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	61 endfor
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	62 else
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	63 varargout = {m.file};
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	64 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	65 else
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	66 print_usage ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	67 endif
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	68
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: diff changeset	69 endfunction
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	70
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	71
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	72 %!test
3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	73 %! str = which ("ls");
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	74 %! assert (str(end-17:end), strcat ("miscellaneous", filesep (), "ls.m"));
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	75 %!test
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14868 diff changeset	76 %! str = which ("amd");
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14868 diff changeset	77 %! assert (str(end-6:end), "amd.oct");
12843 3035c2e130de codesprint: Tests for which.m Rik <octave@nomad.inbox5.com> parents: 11547 diff changeset	78
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79 %!assert (which ("_NO_SUCH_NAME_"), "")
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	80
18451 2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	81 %!test
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	82 %! x = 3;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	83 %! str = which ("x");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	84 %! assert (str, "variable");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	85
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	86 %!test
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	87 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	88 %! assert (str(end-6:end), "amd.oct");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	89 %! amd = 12;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	90 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	91 %! assert (str, "variable");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	92 %! clear amd;
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	93 %! str = which ("amd");
2bd78ab75b23 which: Properly identify workspace variables (bug #37320) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	94 %! assert (str(end-6:end), "amd.oct");

Mercurial > octave

annotate scripts/help/which.m @ 20158:7503499a252b stable