Mercurial > octave-antonio

comparison scripts/strings/strjoin.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
21 ## @deftypefn {Function File} {@var{str} =} strjoin (@var{cstr}) 21 ## @deftypefn {Function File} {@var{str} =} strjoin (@var{cstr})
22 ## @deftypefnx {Function File} {@var{str} =} strjoin (@var{cstr}, @var{delimiter}) 22 ## @deftypefnx {Function File} {@var{str} =} strjoin (@var{cstr}, @var{delimiter})
23 ## Join the elements of the cell string array, @var{cstr}, into a single 23 ## Join the elements of the cell string array, @var{cstr}, into a single
24 ## string. 24 ## string.
25 ## 25 ##
26 ## If no @var{delimiter} is specified, the elements of @var{cstr} 26 ## If no @var{delimiter} is specified, the elements of @var{cstr} are
27 ## separated by a space. 27 ## separated by a space.
28 ## 28 ##
29 ## If @var{delimiter} is specified as a string, the cell string array is 29 ## If @var{delimiter} is specified as a string, the cell string array is
30 ## joined using the string. Escape sequences are supported. 30 ## joined using the string. Escape sequences are supported.
31 ## 31 ##
32 ## If @var{delimiter} is a cell string array whose length is one less 32 ## If @var{delimiter} is a cell string array whose length is one less than
33 ## than @var{cstr}, then the elements of @var{cstr} are joined by 33 ## @var{cstr}, then the elements of @var{cstr} are joined by interleaving the
34 ## interleaving the cell string elements of @var{delimiter}. Escape 34 ## cell string elements of @var{delimiter}. Escape sequences are not
35 ## sequences are not supported. 35 ## supported.
36 ## 36 ##
37 ## @example 37 ## @example
38 ## @group 38 ## @group
39 ## strjoin (@{'Octave','Scilab','Lush','Yorick'@}, '*') 39 ## strjoin (@{'Octave','Scilab','Lush','Yorick'@}, '*')
40 ## @result{} 'Octave*Scilab*Lush*Yorick' 40 ## @result{} 'Octave*Scilab*Lush*Yorick'