comparison src/dirfns.cc @ 12291:b6840c49fbdb release-3-4-x

Add S_ISBLK and family of functions to documentation. Improve docstrings for functions in System Utilities::File Utilities.
author Rik <octave@nomad.inbox5.com>
date Sat, 29 Jan 2011 21:28:38 -0800
parents 7d6d8c1e471f
children f96b9b9f141b
comparison
equal deleted inserted replaced
12290:75a496c7a3df 12291:b6840c49fbdb
155 strings. If an error occurs, return an empty cell array in @var{files}.\n\ 155 strings. If an error occurs, return an empty cell array in @var{files}.\n\
156 \n\ 156 \n\
157 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ 157 If successful, @var{err} is 0 and @var{msg} is an empty string.\n\
158 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ 158 Otherwise, @var{err} is nonzero and @var{msg} contains a\n\
159 system-dependent error message.\n\ 159 system-dependent error message.\n\
160 @seealso{dir, glob}\n\ 160 @seealso{ls, dir, glob}\n\
161 @end deftypefn") 161 @end deftypefn")
162 { 162 {
163 octave_value_list retval; 163 octave_value_list retval;
164 164
165 retval(2) = std::string (); 165 retval(2) = std::string ();
582 @{\n\ 582 @{\n\
583 [1,1] = file1\n\ 583 [1,1] = file1\n\
584 [2,1] = file2\n\ 584 [2,1] = file2\n\
585 @}\n\ 585 @}\n\
586 @end example\n\ 586 @end example\n\
587 @seealso{dir, ls, stat, readdir, regexp}\n\ 587 @seealso{ls, dir, readdir}\n\
588 @end deftypefn") 588 @end deftypefn")
589 { 589 {
590 octave_value retval; 590 octave_value retval;
591 591
592 if (args.length () == 1) 592 if (args.length () == 1)
682 "-*- texinfo -*-\n\ 682 "-*- texinfo -*-\n\
683 @deftypefn {Built-in Function} {} filesep ()\n\ 683 @deftypefn {Built-in Function} {} filesep ()\n\
684 @deftypefnx {Built-in Function} {} filesep ('all')\n\ 684 @deftypefnx {Built-in Function} {} filesep ('all')\n\
685 Return the system-dependent character used to separate directory names.\n\ 685 Return the system-dependent character used to separate directory names.\n\
686 \n\ 686 \n\
687 If 'all' is given, the function return all valid file separators in\n\ 687 If 'all' is given, the function returns all valid file separators in\n\
688 the form of a string. The list of file separators is system-dependent.\n\ 688 the form of a string. The list of file separators is system-dependent.\n\
689 It is / (forward slash) under UNIX or Mac OS X, / and \\ (forward and\n\ 689 It is @samp{/} (forward slash) under UNIX or Mac OS X, @samp{/} and @samp{\\}\n\
690 backward slashes) under Windows.\n\ 690 (forward and backward slashes) under Windows.\n\
691 @seealso{pathsep, dir, ls}\n\ 691 @seealso{pathsep}\n\
692 @end deftypefn") 692 @end deftypefn")
693 { 693 {
694 octave_value retval; 694 octave_value retval;
695 695
696 if (args.length () == 0) 696 if (args.length () == 0)
717 717
718 DEFUN (pathsep, args, nargout, 718 DEFUN (pathsep, args, nargout,
719 "-*- texinfo -*-\n\ 719 "-*- texinfo -*-\n\
720 @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\ 720 @deftypefn {Built-in Function} {@var{val} =} pathsep ()\n\
721 @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\ 721 @deftypefnx {Built-in Function} {@var{old_val} =} pathsep (@var{new_val})\n\
722 Query or set the character used to separate directories in\n\ 722 Query or set the character used to separate directories in a path.\n\
723 a path.\n\ 723 @seealso{filesep}\n\
724 @seealso{filesep, dir, ls}\n\
725 @end deftypefn") 724 @end deftypefn")
726 { 725 {
727 octave_value retval; 726 octave_value retval;
728 727
729 int nargin = args.length (); 728 int nargin = args.length ();