diff scripts/gui/uiputfile.m @ 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 99aa1bcb8848
children f658d41003e4
line wrap: on
line diff
--- 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