Mercurial > octave-antonio

comparison scripts/miscellaneous/computer.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 4197fc428c7d
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
20 ## @deftypefn {Function File} {} computer () 20 ## @deftypefn {Function File} {} computer ()
21 ## @deftypefnx {Function File} {@var{c} =} computer () 21 ## @deftypefnx {Function File} {@var{c} =} computer ()
22 ## @deftypefnx {Function File} {[@var{c}, @var{maxsize}] =} computer () 22 ## @deftypefnx {Function File} {[@var{c}, @var{maxsize}] =} computer ()
23 ## @deftypefnx {Function File} {[@var{c}, @var{maxsize}, @var{endian}] =} computer () 23 ## @deftypefnx {Function File} {[@var{c}, @var{maxsize}, @var{endian}] =} computer ()
24 ## @deftypefnx {Function File} {@var{arch} =} computer ("arch") 24 ## @deftypefnx {Function File} {@var{arch} =} computer ("arch")
25 ## Print or return a string of the form @var{cpu}-@var{vendor}-@var{os} 25 ## Print or return a string of the form @var{cpu}-@var{vendor}-@var{os} that
26 ## that identifies the type of computer that Octave is running on. 26 ## identifies the type of computer that Octave is running on.
27 ## 27 ##
28 ## If invoked with an output argument, the value is returned instead of 28 ## If invoked with an output argument, the value is returned instead of
29 ## printed. For example: 29 ## printed. For example:
30 ## 30 ##
31 ## @example 31 ## @example
36 ## mycomp = computer () 36 ## mycomp = computer ()
37 ## @result{} mycomp = "i586-pc-linux-gnu" 37 ## @result{} mycomp = "i586-pc-linux-gnu"
38 ## @end group 38 ## @end group
39 ## @end example 39 ## @end example
40 ## 40 ##
41 ## If two output arguments are requested, also return the maximum number 41 ## If two output arguments are requested, also return the maximum number of
42 ## of elements for an array. This will depend on whether Octave has been 42 ## elements for an array. This will depend on whether Octave has been
43 ## compiled with 32-bit or 64-bit index vectors. 43 ## compiled with 32-bit or 64-bit index vectors.
44 ## 44 ##
45 ## If three output arguments are requested, also return the byte order 45 ## If three output arguments are requested, also return the byte order of the
46 ## of the current system as a character (@qcode{"B"} for big-endian or 46 ## current system as a character (@qcode{"B"} for big-endian or @qcode{"L"}
47 ## @qcode{"L"} for little-endian). 47 ## for little-endian).
48 ## 48 ##
49 ## If the argument @qcode{"arch"} is specified, return a string indicating the 49 ## If the argument @qcode{"arch"} is specified, return a string indicating the
50 ## architecture of the computer on which Octave is running. 50 ## architecture of the computer on which Octave is running.
51 ## @seealso{isunix, ismac, ispc} 51 ## @seealso{isunix, ismac, ispc}
52 ## @end deftypefn 52 ## @end deftypefn