comparison scripts/strings/dec2hex.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 9fc020886ae9
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} dec2hex (@var{d}, @var{len}) 20 ## @deftypefn {Function File} {} dec2hex (@var{d}, @var{len})
21 ## Return the hexadecimal string corresponding to the non-negative 21 ## Return the hexadecimal string corresponding to the non-negative integer
22 ## integer @var{d}. For example: 22 ## @var{d}.
23 ##
24 ## For example:
23 ## 25 ##
24 ## @example 26 ## @example
25 ## @group 27 ## @group
26 ## dec2hex (2748) 28 ## dec2hex (2748)
27 ## @result{} "ABC" 29 ## @result{} "ABC"
28 ## @end group 30 ## @end group
29 ## @end example 31 ## @end example
30 ## 32 ##
31 ## If @var{d} is a matrix or cell array, return a string matrix with one 33 ## If @var{d} is a matrix or cell array, return a string matrix with one row
32 ## row per element in @var{d}, padded with leading zeros to the width of 34 ## per element in @var{d}, padded with leading zeros to the width of the
33 ## the largest value. 35 ## largest value.
34 ## 36 ##
35 ## The optional second argument, @var{len}, specifies the minimum 37 ## The optional second argument, @var{len}, specifies the minimum number of
36 ## number of digits in the result. 38 ## digits in the result.
37 ## @seealso{hex2dec, dec2base, dec2bin} 39 ## @seealso{hex2dec, dec2base, dec2bin}
38 ## @end deftypefn 40 ## @end deftypefn
39 41
40 ## Author: Daniel Calvelo <dcalvelo@yahoo.com> 42 ## Author: Daniel Calvelo <dcalvelo@yahoo.com>
41 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk> 43 ## Adapted-by: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>