Mercurial > hg > octave-lyh
diff libinterp/corefcn/syscalls.cc @ 17405:0bf2fc8562c9
doc: Update documentation for file and directory functions.
* libinterp/corefcn/dirfns.cc(Fpwd, Freaddir, Fmkdir, Frmdir, Freadlink, Ffnmatch): Redo docstring.
* libinterp/corefcn/dirfns.cc(Fcd): Redo docstring. Return previous working
directory if nargout > 0.
* libinterp/corefcn/dirfns.cc(Flink, Fsymlink, Frename): Redo docstring.
Re-order return values so that highest numbered value is assigned first to
avoid re-sizing octave_value_list each time.
* libinterp/corefcn/syscalls.cc(Flstat, Fmkfifo, FS_ISREG, FS_ISDIR, FS_ISCHR,
FS_ISBLK, FS_ISFIFO, FS_ISLNK, FS_ISSOCK): Redo docstring.
* scripts/general/isdir.m: Add more xrefs to @seealso.
* scripts/miscellaneous/copyfile.m: Add more xrefs to @seealso.
* scripts/miscellaneous/dir.m: Redo docstring.
* scripts/miscellaneous/ls.m: Add more xrefs to @seealso.m.
* scripts/miscellaneous/movefile.m: Add more xrefs to @seealso.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 09 Sep 2013 14:30:31 -0700 |
parents | bc924baa2c4e |
children |
line wrap: on
line diff
--- a/libinterp/corefcn/syscalls.cc +++ b/libinterp/corefcn/syscalls.cc @@ -749,11 +749,13 @@ DEFUNX ("lstat", Flstat, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{symlink})\n\ +@deftypefn {Built-in Function} {@var{info} =} lstat (@var{symlink})\n\ +@deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{symlink})\n\ Return a structure @var{info} containing information about the symbolic link\n\ -@var{symlink}. The function outputs are described in the documentation for\n\ -@code{stat}.\n\ -@seealso{stat}\n\ +@var{symlink}.\n\ +\n\ +The function outputs are described in the documentation for @code{stat}.\n\ +@seealso{stat, symlink}\n\ @end deftypefn") { octave_value_list retval; @@ -777,12 +779,14 @@ DEFUNX ("mkfifo", Fmkfifo, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\ -Create a @var{fifo} special file named @var{name} with file mode @var{mode}\n\ +@deftypefn {Built-in Function} {} mkfifo (@var{name}, @var{mode})\n\ +@deftypefnx {Built-in Function} {[@var{err}, @var{msg}] =} mkfifo (@var{name}, @var{mode})\n\ +Create a FIFO special file named @var{name} with file mode @var{mode}\n\ \n\ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ +@seealso{pipe}\n\ @end deftypefn") { octave_value_list retval; @@ -837,6 +841,7 @@ If successful, @var{err} is 0 and @var{msg} is an empty string.\n\ Otherwise, @var{err} is nonzero and @var{msg} contains a\n\ system-dependent error message.\n\ +@seealso{mkfifo}\n\ @end deftypefn") { octave_value_list retval; @@ -975,6 +980,7 @@ @result{} err = 0\n\ @result{} msg =\n\ @end example\n\ +@seealso{lstat, ls, dir}\n\ @end deftypefn") { octave_value_list retval; @@ -1013,8 +1019,9 @@ DEFUNX ("S_ISREG", FS_ISREG, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISREG (@var{mode})\n\ -Return true if @var{mode} corresponds to a regular file. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a regular file.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") { @@ -1038,8 +1045,9 @@ DEFUNX ("S_ISDIR", FS_ISDIR, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISDIR (@var{mode})\n\ -Return true if @var{mode} corresponds to a directory. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a directory.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") { @@ -1063,8 +1071,9 @@ DEFUNX ("S_ISCHR", FS_ISCHR, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISCHR (@var{mode})\n\ -Return true if @var{mode} corresponds to a character device. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a character device.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") { @@ -1088,8 +1097,9 @@ DEFUNX ("S_ISBLK", FS_ISBLK, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISBLK (@var{mode})\n\ -Return true if @var{mode} corresponds to a block device. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a block device.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") { @@ -1113,8 +1123,9 @@ DEFUNX ("S_ISFIFO", FS_ISFIFO, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISFIFO (@var{mode})\n\ -Return true if @var{mode} corresponds to a fifo. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a fifo.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") { @@ -1138,8 +1149,9 @@ DEFUNX ("S_ISLNK", FS_ISLNK, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISLNK (@var{mode})\n\ -Return true if @var{mode} corresponds to a symbolic link. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a symbolic link.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") { @@ -1163,8 +1175,9 @@ DEFUNX ("S_ISSOCK", FS_ISSOCK, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} S_ISSOCK (@var{mode})\n\ -Return true if @var{mode} corresponds to a socket. The value\n\ -of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ +Return true if @var{mode} corresponds to a socket.\n\ +\n\ +The value of @var{mode} is assumed to be returned from a call to @code{stat}.\n\ @seealso{stat, lstat}\n\ @end deftypefn") {