Mercurial > octave-nkf
changeset 14819:67b6b47a22f6
doc: Clarify docstrings for canonicalize_file_name, make_absolute_filename
* syscalls.cc (canonicalize_file_name): Clarify docstring.
* utils.cc (make_absolute_filename): Clarify docstring.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 29 Jun 2012 13:38:28 -0700 |
| parents | c6ae30f73946 |
| children | aad7d7ee8e8a |
| files | src/syscalls.cc src/utils.cc |
| diffstat | 2 files changed, 7 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/src/syscalls.cc Fri Jun 29 08:45:54 2012 -0700 +++ b/src/syscalls.cc Fri Jun 29 13:38:28 2012 -0700 @@ -1594,8 +1594,10 @@ DEFUNX ("canonicalize_file_name", Fcanonicalize_file_name, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{cname}, @var{status}, @var{msg}]} canonicalize_file_name (@var{name})\n\ -Return the canonical name of file @var{name}.\n\ +@deftypefn {Built-in Function} {[@var{cname}, @var{status}, @var{msg}] =} canonicalize_file_name (@var{fname})\n\ +Return the canonical name of file @var{fname}. If the file does not exist\n\ +the empty string (\"\") is returned.\n\ +@seealso{make_absolute_filename, is_absolute_filename, is_rooted_relative_filename}\n\ @end deftypefn") { octave_value_list retval;
--- a/src/utils.cc Fri Jun 29 08:45:54 2012 -0700 +++ b/src/utils.cc Fri Jun 29 13:38:28 2012 -0700 @@ -862,8 +862,9 @@ DEFUN (make_absolute_filename, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} make_absolute_filename (@var{file})\n\ -Return the full name of @var{file}, relative to the current directory.\n\ -@seealso{is_absolute_filename, is_rooted_relative_filename, isdir}\n\ +Return the full name of @var{file} beginning from the root of the file\n\ +system. No check is done for the existence of @var{file}.\n\ +@seealso{canonicalize_file_name, is_absolute_filename, is_rooted_relative_filename, isdir}\n\ @end deftypefn") { octave_value retval = std::string ();