Mercurial > octave-nkf

comparison libinterp/corefcn/dirfns.cc @ 20207:4f45eaf83908 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 19755f4fc851
children 2ae4a7ef4378
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
172 Return the names of files in the directory @var{dir} as a cell array of\n\ 172 Return the names of files in the directory @var{dir} as a cell array of\n\
173 strings.\n\ 173 strings.\n\
174 \n\ 174 \n\
175 If an error occurs, return an empty cell array in @var{files}.\n\ 175 If an error occurs, return an empty cell array in @var{files}.\n\
176 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ 176 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
177 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ 177 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
178 system-dependent error message.\n\ 178 error message.\n\
179 @seealso{ls, dir, glob, what}\n\ 179 @seealso{ls, dir, glob, what}\n\
180 @end deftypefn") 180 @end deftypefn")
181 { 181 {
182 octave_value_list retval; 182 octave_value_list retval;
183 183
308 @deftypefn {Built-in Function} {} rmdir @var{dir}\n\ 308 @deftypefn {Built-in Function} {} rmdir @var{dir}\n\
309 @deftypefnx {Built-in Function} {} rmdir (@var{dir}, \"s\")\n\ 309 @deftypefnx {Built-in Function} {} rmdir (@var{dir}, \"s\")\n\
310 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@dots{})\n\ 310 @deftypefnx {Built-in Function} {[@var{status}, @var{msg}, @var{msgid}] =} rmdir (@dots{})\n\
311 Remove the directory named @var{dir}.\n\ 311 Remove the directory named @var{dir}.\n\
312 \n\ 312 \n\
313 If the optional second parameter is supplied with value @qcode{\"s\"},\n\
314 recursively remove all subdirectories as well.\n\
315 \n\
313 If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty\n\ 316 If successful, @var{status} is 1, and @var{msg}, @var{msgid} are empty\n\
314 character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a\n\ 317 character strings (""). Otherwise, @var{status} is 0, @var{msg} contains a\n\
315 system-dependent error message, and @var{msgid} contains a unique message\n\ 318 system-dependent error message, and @var{msgid} contains a unique message\n\
316 identifier.\n\ 319 identifier.\n\
317 \n\ 320 \n\
318 If the optional second parameter is supplied with value @qcode{\"s\"},\n\
319 recursively remove all subdirectories as well.\n\
320 @seealso{mkdir, confirm_recursive_rmdir, pwd}\n\ 321 @seealso{mkdir, confirm_recursive_rmdir, pwd}\n\
321 @end deftypefn") 322 @end deftypefn")
322 { 323 {
323 octave_value_list retval; 324 octave_value_list retval;
324 325
384 @deftypefn {Built-in Function} {} link @var{old} @var{new}\n\ 385 @deftypefn {Built-in Function} {} link @var{old} @var{new}\n\
385 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} link (@var{old}, @var{new})\n\ 386 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} link (@var{old}, @var{new})\n\
386 Create a new link (also known as a hard link) to an existing file.\n\ 387 Create a new link (also known as a hard link) to an existing file.\n\
387 \n\ 388 \n\
388 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ 389 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
389 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ 390 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
390 system-dependent error message.\n\ 391 error message.\n\
391 @seealso{symlink, unlink, readlink, lstat}\n\ 392 @seealso{symlink, unlink, readlink, lstat}\n\
392 @end deftypefn") 393 @end deftypefn")
393 { 394 {
394 octave_value_list retval; 395 octave_value_list retval;
395 396
431 @deftypefn {Built-in Function} {} symlink @var{old} @var{new}\n\ 432 @deftypefn {Built-in Function} {} symlink @var{old} @var{new}\n\
432 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} symlink (@var{old}, @var{new})\n\ 433 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} symlink (@var{old}, @var{new})\n\
433 Create a symbolic link @var{new} which contains the string @var{old}.\n\ 434 Create a symbolic link @var{new} which contains the string @var{old}.\n\
434 \n\ 435 \n\
435 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ 436 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
436 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ 437 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
437 system-dependent error message.\n\ 438 error message.\n\
438 @seealso{link, unlink, readlink, lstat}\n\ 439 @seealso{link, unlink, readlink, lstat}\n\
439 @end deftypefn") 440 @end deftypefn")
440 { 441 {
441 octave_value_list retval; 442 octave_value_list retval;
442 443
522 @deftypefn {Built-in Function} {} rename @var{old} @var{new}\n\ 523 @deftypefn {Built-in Function} {} rename @var{old} @var{new}\n\
523 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} rename (@var{old}, @var{new})\n\ 524 @deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} rename (@var{old}, @var{new})\n\
524 Change the name of file @var{old} to @var{new}.\n\ 525 Change the name of file @var{old} to @var{new}.\n\
525 \n\ 526 \n\
526 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ 527 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
527 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ 528 Otherwise, @var{err} is nonzero and @var{msg} contains a system-dependent\n\
528 system-dependent error message.\n\ 529 error message.\n\
529 @seealso{movefile, copyfile, ls, dir}\n\ 530 @seealso{movefile, copyfile, ls, dir}\n\
530 @end deftypefn") 531 @end deftypefn")
531 { 532 {
532 octave_value_list retval; 533 octave_value_list retval;
533 534
567 DEFUN (glob, args, , 568 DEFUN (glob, args, ,
568 "-*- texinfo -*-\n\ 569 "-*- texinfo -*-\n\
569 @deftypefn {Built-in Function} {} glob (@var{pattern})\n\ 570 @deftypefn {Built-in Function} {} glob (@var{pattern})\n\
570 Given an array of pattern strings (as a char array or a cell array) in\n\ 571 Given an array of pattern strings (as a char array or a cell array) in\n\
571 @var{pattern}, return a cell array of file names that match any of\n\ 572 @var{pattern}, return a cell array of file names that match any of\n\
572 them, or an empty cell array if no patterns match. The pattern strings are\n\ 573 them, or an empty cell array if no patterns match.\n\
573 interpreted as filename globbing patterns (as they are used by Unix shells).\n\ 574 \n\
575 The pattern strings are interpreted as filename globbing patterns (as they\n\
576 are used by Unix shells).\n\
577 \n\
574 Within a pattern\n\ 578 Within a pattern\n\
575 \n\ 579 \n\
576 @table @code\n\ 580 @table @code\n\
577 @item *\n\ 581 @item *\n\
578 matches any string, including the null string,\n\ 582 matches any string, including the null string,\n\
668 DEFUN (__fnmatch__, args, , 672 DEFUN (__fnmatch__, args, ,
669 "-*- texinfo -*-\n\ 673 "-*- texinfo -*-\n\
670 @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\ 674 @deftypefn {Built-in Function} {} fnmatch (@var{pattern}, @var{string})\n\
671 Return true or false for each element of @var{string} that matches any of\n\ 675 Return true or false for each element of @var{string} that matches any of\n\
672 the elements of the string array @var{pattern}, using the rules of\n\ 676 the elements of the string array @var{pattern}, using the rules of\n\
677 \n\
673 filename pattern matching. For example:\n\ 678 filename pattern matching. For example:\n\
674 \n\ 679 \n\
675 @example\n\ 680 @example\n\
676 @group\n\ 681 @group\n\
677 fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\ 682 fnmatch (\"a*b\", @{\"ab\"; \"axyzb\"; \"xyzab\"@})\n\
792 @deftypefnx {Built-in Function} {} confirm_recursive_rmdir (@var{new_val}, \"local\")\n\ 797 @deftypefnx {Built-in Function} {} confirm_recursive_rmdir (@var{new_val}, \"local\")\n\
793 Query or set the internal variable that controls whether Octave\n\ 798 Query or set the internal variable that controls whether Octave\n\
794 will ask for confirmation before recursively removing a directory tree.\n\ 799 will ask for confirmation before recursively removing a directory tree.\n\
795 \n\ 800 \n\
796 When called from inside a function with the @qcode{\"local\"} option, the\n\ 801 When called from inside a function with the @qcode{\"local\"} option, the\n\
797 variable is changed locally for the function and any subroutines it calls. \n\ 802 variable is changed locally for the function and any subroutines it calls.\n\
798 The original variable value is restored when exiting the function.\n\ 803 The original variable value is restored when exiting the function.\n\
799 @seealso{rmdir}\n\ 804 @seealso{rmdir}\n\
800 @end deftypefn") 805 @end deftypefn")
801 { 806 {
802 return SET_INTERNAL_VARIABLE (confirm_recursive_rmdir); 807 return SET_INTERNAL_VARIABLE (confirm_recursive_rmdir);