Mercurial > octave
view scripts/legacy/isdir.m @ 30329:81d26e8481a6
maint: Shorten @seealso lines to less than 80 characters (bug #57599)
* chol.cc, data.cc, debug.cc, file-io.cc, load-save.cc, oct-hist.cc,
pr-output.cc, sparse.cc, syscalls.cc, time.cc, utils.cc, ov-struct.cc,
base64decode.m, base64encode.m, getappdata.m, isappdata.m, setappdata.m,
colormap.m, isdir.m, cast.m, getfield.m, isfile.m, isfolder.m, setfield.m,
contour.m, contour3.m, contourf.m, ezplot.m, isosurface.m, mesh.m, meshc.m,
meshz.m, plot.m, surf.m, surfc.m, waterfall.m, movmad.m, movmax.m, movmean.m,
movmedian.m, movmin.m, movprod.m, movstd.m, movsum.m, movvar.m:
Shorten @seealso lines to less than 80 characters.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 23 Nov 2021 11:26:38 -0800 |
parents | 7854d5752dd2 |
children | 83aeaba707d8 796f54d4ddbf |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2004-2021 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} isdir (@var{f}) ## ## This function is not recommended. Use @code{isfolder} or ## @code{file_in_loadpath} instead. ## ## Return true if @var{f} is a directory and false otherwise. ## ## Compatibility Note: The @sc{matlab} function of the same name will also ## search for @var{f} in the load path directories. To emulate this behavior ## use ## ## @example ## @var{tf} = ! isempty (file_in_loadpath (@var{f})) ## @end example ## ## @seealso{isfolder, file_in_loadpath, exist, stat, is_absolute_filename, ## is_rooted_relative_filename} ## @end deftypefn function retval = isdir (f) persistent warned = false; if (! warned) warned = true; warning ("Octave:legacy-function", "isdir is obsolete; use isfolder or dir_in_loadpath instead\n"); endif if (nargin < 1) print_usage (); endif ## Exist returns an integer but isdir should return a logical. retval = (exist (f, "dir") == 7); endfunction ## First test is necessary to provoke 1-time legacy warning %!test %! warning ("off", "Octave:legacy-function", "local"); %! isdir (pwd ()); %!assert (isdir (pwd ())) %!assert (! isdir (tempname ())) %!error <Invalid call> isdir ()