Mercurial > hg > octave-nkf

diff src/syscalls.cc @ 12211:11faa69c4eaa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 12df7854fa7c
children f1ab2a12b4f4
line wrap: on
line diff
--- a/src/syscalls.cc
+++ b/src/syscalls.cc
@@ -743,8 +743,11 @@
 
 DEFUNX ("lstat", Flstat, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{file})\n\
-See stat.\n\
+@deftypefn {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\
 @end deftypefn")
 {
   octave_value_list retval;
@@ -880,7 +883,7 @@
 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} stat (@var{fid})\n\
 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{file})\n\
 @deftypefnx {Built-in Function} {[@var{info}, @var{err}, @var{msg}] =} lstat (@var{fid})\n\
-Return a structure @var{s} containing the following information about\n\
+Return a structure @var{info} containing the following information about\n\
 @var{file} or file identifier @var{fid}.\n\
 \n\
 @table @code\n\