Mercurial > octave-antonio

comparison scripts/miscellaneous/fullfile.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{filename} =} fullfile (@var{dir1}, @var{dir2}, @dots{}, @var{file}) 20 ## @deftypefn {Function File} {@var{filename} =} fullfile (@var{dir1}, @var{dir2}, @dots{}, @var{file})
21 ## @deftypefnx {Function File} {@var{filenames} =} fullfile (@dots{}, @var{files}) 21 ## @deftypefnx {Function File} {@var{filenames} =} fullfile (@dots{}, @var{files})
22 ## Build complete filename from separate parts. 22 ## Build complete filename from separate parts.
23 ## 23 ##
24 ## Joins any number of path components intelligently. The return value 24 ## Joins any number of path components intelligently. The return value is
25 ## is the concatenation of each component with exactly one file separator 25 ## the concatenation of each component with exactly one file separator
26 ## between each non empty part and at most one leading and/or trailing file 26 ## between each non empty part and at most one leading and/or trailing file
27 ## separator. 27 ## separator.
28 ## 28 ##
29 ## If the last component part is a cell array, returns a cell array of 29 ## If the last component part is a cell array, returns a cell array of
30 ## filepaths, one for each element in the last component, e.g.: 30 ## filepaths, one for each element in the last component, e.g.:
36 ## /home/username/data/f2.csv 36 ## /home/username/data/f2.csv
37 ## /home/username/data/f3.csv 37 ## /home/username/data/f3.csv
38 ## @end group 38 ## @end group
39 ## @end example 39 ## @end example
40 ## 40 ##
41 ## On Windows systems, while forward slash file separators do work, they 41 ## On Windows systems, while forward slash file separators do work, they are
42 ## are replaced by backslashes; in addition drive letters are stripped of 42 ## replaced by backslashes; in addition drive letters are stripped of leading
43 ## leading file separators to obtain a valid file path. 43 ## file separators to obtain a valid file path.
44 ## 44 ##
45 ## @seealso{fileparts, filesep} 45 ## @seealso{fileparts, filesep}
46 ## @end deftypefn 46 ## @end deftypefn
47 47
48 ## Author: Carnë Draug <carandraug@octave.org> 48 ## Author: Carnë Draug <carandraug@octave.org>