Mercurial > octave

changeset 25040:328518881291 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add command forms to documentation of copyfile, mkdir, movefile. * copyfile.m, mkdir.m, movefile.m: Add command forms to documentation.
author Rik <rik@octave.org>
date Wed, 28 Mar 2018 13:12:01 -0700
parents 40a65b30fadf
children d5d61f1b6de0
files scripts/miscellaneous/copyfile.m scripts/miscellaneous/mkdir.m scripts/miscellaneous/movefile.m
diffstat 3 files changed, 27 insertions(+), 15 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/miscellaneous/copyfile.m	Wed Mar 28 13:11:00 2018 -0700
+++ b/scripts/miscellaneous/copyfile.m	Wed Mar 28 13:12:01 2018 -0700
@@ -17,12 +17,16 @@
 ## <https://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2})
-## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2}, 'f')
-## Copy the source files or directories @var{f1} to the destination @var{f2}.
+## @deftypefn  {} {} copyfile @var{f1} @var{f2}
+## @deftypefnx {} {} copyfile @var{f1} @var{f2} f
+## @deftypefnx {} {} copyfile (@var{f1}, @var{f2})
+## @deftypefnx {} {} copyfile (@var{f1}, @var{f2}, 'f')
+## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@dots{})
+## Copy the source file(s) or directory @var{f1} to the destination @var{f2}.
 ##
-## The name @var{f1} may contain globbing patterns.  If @var{f1} expands to
-## multiple filenames, @var{f2} must be a directory.
+## The name @var{f1} may contain globbing patterns, or may be a cell array of
+## strings.  If @var{f1} expands to multiple filenames, @var{f2} must be a
+## directory.
 ##
 ## When the force flag @qcode{'f'} is given any existing files will be
 ## overwritten without prompting.
--- a/scripts/miscellaneous/mkdir.m	Wed Mar 28 13:11:00 2018 -0700
+++ b/scripts/miscellaneous/mkdir.m	Wed Mar 28 13:12:01 2018 -0700
@@ -16,13 +16,15 @@
 ## <https://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {} {} mkdir @var{dir}
-## @deftypefnx {} {} mkdir (@var{parent}, @var{dir})
+## @deftypefn  {} {} mkdir @var{dirname}
+## @deftypefnx {} {} mkdir @var{parent} @var{dirname}
+## @deftypefnx {} {} mkdir (@var{dirname})
+## @deftypefnx {} {} mkdir (@var{parent}, @var{dirname})
 ## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} mkdir (@dots{})
-## Create a directory named @var{dir} in the directory @var{parent},
+## Create a directory named @var{dirname} in the directory @var{parent},
 ## creating any intermediate directories if necessary.
 ##
-## If @var{dir} is a relative path and no @var{parent} directory is specified
+## If @var{dir} is a relative path, and no @var{parent} directory is specified,
 ## then the present working directory is used.
 ##
 ## If successful, @var{status} is 1, and @var{msg} and @var{msgid} are empty
--- a/scripts/miscellaneous/movefile.m	Wed Mar 28 13:11:00 2018 -0700
+++ b/scripts/miscellaneous/movefile.m	Wed Mar 28 13:12:01 2018 -0700
@@ -17,16 +17,22 @@
 ## <https://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {} {} movefile (@var{f1})
+## @deftypefn  {} {} movefile @var{f1}
+## @deftypefnx {} {} movefile @var{f1} @var{f2}
+## @deftypefnx {} {} movefile @var{f1} @var{f2} f
+## @deftypefnx {} {} movefile (@var{f1})
 ## @deftypefnx {} {} movefile (@var{f1}, @var{f2})
 ## @deftypefnx {} {} movefile (@var{f1}, @var{f2}, 'f')
 ## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@dots{})
-## Move the source files or directories @var{f1} to the destination @var{f2}.
+## Move the source file or directory @var{f1} to the destination @var{f2}.
 ##
-## The name @var{f1} may contain globbing patterns.  If @var{f1} expands to
-## multiple filenames, @var{f2} must be a directory.  If no destination
-## @var{f2} is specified then the destination is the present working directory.
-## If @var{f2} is a filename then @var{f1} is renamed to @var{f2}.
+## The name @var{f1} may contain globbing patterns, or may be a cell array of
+## strings.  If @var{f1} expands to multiple filenames, @var{f2} must be a
+## directory.
+##
+## If no destination @var{f2} is specified then the destination is the present
+## working directory.  If @var{f2} is a filename then @var{f1} is renamed to
+## @var{f2}.
 ##
 ## When the force flag @qcode{'f'} is given any existing files will be
 ## overwritten without prompting.