comparison scripts/strings/untabify.m @ 20164:df437a52bcaf stable

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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} untabify (@var{t}) 20 ## @deftypefn {Function File} {} untabify (@var{t})
21 ## @deftypefnx {Function File} {} untabify (@var{t}, @var{tw}) 21 ## @deftypefnx {Function File} {} untabify (@var{t}, @var{tw})
22 ## @deftypefnx {Function File} {} untabify (@var{t}, @var{tw}, @var{deblank}) 22 ## @deftypefnx {Function File} {} untabify (@var{t}, @var{tw}, @var{deblank})
23 ## Replace TAB characters in @var{t}, with spaces. 23 ## Replace TAB characters in @var{t} with spaces.
24 ## The tab width is specified by @var{tw}, or defaults to eight.
25 ## The input, @var{t}, may be either a 2-D character array, or a cell
26 ## array of character strings. The output is the same class
27 ## as the input.
28 ## 24 ##
29 ## If the optional argument @var{deblank} is true, then the spaces will 25 ## The input, @var{t}, may be either a 2-D character array, or a cell array of
30 ## be removed from the end of the character data. 26 ## character strings. The output is the same class as the input.
27 ##
28 ## The tab width is specified by @var{tw}, and defaults to eight.
31 ## 29 ##
32 ## The following example reads a file and writes an untabified version 30 ## If the optional argument @var{deblank} is true, then the spaces will be
33 ## of the same file with trailing spaces stripped. 31 ## removed from the end of the character data.
32 ##
33 ## The following example reads a file and writes an untabified version of the
34 ## same file with trailing spaces stripped.
34 ## 35 ##
35 ## @example 36 ## @example
36 ## @group 37 ## @group
37 ## fid = fopen ("tabbed_script.m"); 38 ## fid = fopen ("tabbed_script.m");
38 ## text = char (fread (fid, "uchar")'); 39 ## text = char (fread (fid, "uchar")');