changeset 27831:b42e4b3dee5d

uigetfile.m, uiputfile.m: Add documentation for output arguments (bug #55419).
author Markus Mützel <markus.muetzel@gmx.de>
date Sat, 14 Dec 2019 19:07:44 +0100
parents 06bb894770e8
children 8fd7d1d2a4ca
files scripts/gui/uigetfile.m scripts/gui/uiputfile.m
diffstat 2 files changed, 16 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/gui/uigetfile.m	Mon Dec 09 14:48:12 2019 +0100
+++ b/scripts/gui/uigetfile.m	Sat Dec 14 19:07:44 2019 +0100
@@ -33,8 +33,9 @@
 ## @table @asis
 ## @item @qcode{"/path/to/filename.ext"}
 ## If a filename is given then the file extension is extracted and used as
-## filter.  In addition, the path is selected as current path and the filename
-## is selected as default file.  Example: @code{uigetfile ("myfun.m")}
+## filter.  In addition, the path is selected as current path in the dialog and
+## the filename is selected as default file.
+## Example: @code{uigetfile ("myfun.m")}
 ##
 ## @item A single file extension @qcode{"*.ext"}
 ## Example: @code{uigetfile ("*.ext")}
@@ -56,7 +57,7 @@
 ## is present the parent directory is listed.  The substring to the right of
 ## the rightmost file separator (if any) will be interpreted as a file or
 ## directory name and if that file or directory exists it will be highlighted.
-## If the path name or directory name is wholly or partly nonexistent, the
+## If the path name or directory name is entirely or partly nonexistent, the
 ## current working directory will be displayed.
 ## No filter will be active.
 ## @end table
@@ -71,6 +72,11 @@
 ## coordinates.  Two or more files can be selected when setting the
 ## @qcode{"MultiSelect"} key to @qcode{"on"}.  In that case @var{fname} is a
 ## cell array containing the files.
+##
+## @var{fname} and @var{fpath} contain the chosen name(s) and path,
+## respectively.  @var{fltidx} is the index to list of filter extensions
+## @var{flt} that was selected.
+##
 ## @seealso{uiputfile, uigetdir}
 ## @end deftypefn
 
--- a/scripts/gui/uiputfile.m	Mon Dec 09 14:48:12 2019 +0100
+++ b/scripts/gui/uiputfile.m	Sat Dec 14 19:07:44 2019 +0100
@@ -29,8 +29,8 @@
 ## @table @asis
 ## @item @qcode{"/path/to/filename.ext"}
 ## If a filename is given the file extension is extracted and used as filter.
-## In addition the path is selected as current path and the filename is
-## selected as default file.  Example: @code{uiputfile ("myfun.m")}
+## In addition the path is selected as current path in the dialog and the
+## filename is selected as default file.  Example: @code{uiputfile ("myfun.m")}
 ##
 ## @item @qcode{"*.ext"}
 ## A single file extension.
@@ -51,6 +51,11 @@
 ## @var{dialog_name} can be used to customize the dialog title.
 ## If @var{default_file} is given it is preselected in the GUI dialog.
 ## If, in addition, a path is given it is also used as current path.
+##
+## @var{fname} and @var{fpath} return the chosen name and path, respectivly.
+## @var{fltidx} is the index to list of filter extensions @var{flt} that was
+## selected.
+##
 ## @seealso{uigetfile, uigetdir}
 ## @end deftypefn