comparison scripts/miscellaneous/compare_versions.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
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} compare_versions (@var{v1}, @var{v2}, @var{operator}) 20 ## @deftypefn {Function File} {} compare_versions (@var{v1}, @var{v2}, @var{operator})
21 ## Compare two version strings using the given @var{operator}. 21 ## Compare two version strings using the given @var{operator}.
22 ## 22 ##
23 ## This function assumes that versions @var{v1} and @var{v2} are 23 ## This function assumes that versions @var{v1} and @var{v2} are arbitrarily
24 ## arbitrarily long strings made of numeric and period characters 24 ## long strings made of numeric and period characters possibly followed by an
25 ## possibly followed by an arbitrary string (e.g., @qcode{"1.2.3"}, 25 ## arbitrary string (e.g., @qcode{"1.2.3"}, @qcode{"0.3"}, @qcode{"0.1.2+"},
26 ## @qcode{"0.3"}, @qcode{"0.1.2+"}, or @qcode{"1.2.3.4-test1"}). 26 ## or @qcode{"1.2.3.4-test1"}).
27 ## 27 ##
28 ## The version is first split into numeric and character portions 28 ## The version is first split into numeric and character portions and then
29 ## and then the parts are padded to be the same length (i.e., @qcode{"1.1"} 29 ## the parts are padded to be the same length (i.e., @qcode{"1.1"} would be
30 ## would be padded to be @qcode{"1.1.0"} when being compared with 30 ## padded to be @qcode{"1.1.0"} when being compared with @qcode{"1.1.1"}, and
31 ## @qcode{"1.1.1"}, and separately, the character parts of the strings are 31 ## separately, the character parts of the strings are padded with nulls).
32 ## padded with nulls).
33 ## 32 ##
34 ## The operator can be any logical operator from the set 33 ## The operator can be any logical operator from the set
35 ## 34 ##
36 ## @itemize @bullet 35 ## @itemize @bullet
37 ## @item 36 ## @item