Mercurial > octave
comparison scripts/miscellaneous/unpack.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 81a755db4db4 |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
21 ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir}, @var{filetype}) | 21 ## @deftypefnx {Function File} {@var{files} =} unpack (@var{file}, @var{dir}, @var{filetype}) |
22 ## Unpack the archive @var{file} based on its extension to the directory | 22 ## Unpack the archive @var{file} based on its extension to the directory |
23 ## @var{dir}. If @var{file} is a cellstr, then all files will be | 23 ## @var{dir}. If @var{file} is a cellstr, then all files will be |
24 ## handled individually. If @var{dir} is not specified, it defaults to | 24 ## handled individually. If @var{dir} is not specified, it defaults to |
25 ## the current directory. It returns a list of @var{files} | 25 ## the current directory. It returns a list of @var{files} |
26 ## unpacked. If a directory is in the file list, then the | 26 ## unpacked. If a directory is in the file list, then the |
27 ## @var{filetype} to unpack must also be specified. | 27 ## @var{filetype} to unpack must also be specified. |
28 ## | 28 ## |
29 ## The @var{files} includes the entire path to the output files. | 29 ## The @var{files} includes the entire path to the output files. |
30 ## @seealso{bunzip2, tar, untar, gzip, gunzip, zip, unzip} | 30 ## @seealso{bunzip2, tar, untar, gzip, gunzip, zip, unzip} |
31 ## @end deftypefn | 31 ## @end deftypefn |