diff src/utils.cc @ 12668:e3dc23f7dd54 stable

doc: Improve a few docstrings related to test functions and directories. * what.m, rundemos.m, runtests.m, dirfns.cc (filesep), utils.cc (find_dir_in_path): Improve docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 14 May 2011 21:17:20 -0700
parents 232a90612254
children 7d4f5a033330
line wrap: on
line diff
--- a/src/utils.cc
+++ b/src/utils.cc
@@ -791,7 +791,8 @@
 
 DEFUN (find_dir_in_path, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} find_dir_in_path (@var{dir}, \"all\")\n\
+@deftypefn  {Built-in Function} {} find_dir_in_path (@var{dir})\n\
+@deftypefnx {Built-in Function} {} find_dir_in_path (@var{dir}, \"all\")\n\
 Return the full name of the path element matching @var{dir}.  The\n\
 match is performed at the end of each path element.  For example, if\n\
 @var{dir} is @code{\"foo/bar\"}, it matches the path element\n\
@@ -799,7 +800,7 @@
 or @code{\"/some/dir/allfoo/bar\"}.\n\
 \n\
 The second argument is optional.  If it is supplied, return a cell array\n\
-containing all the directory names that match.\n\
+containing all name matches rather than just the first.\n\
 @end deftypefn")
 {
   octave_value retval = std::string ();