Mercurial > octave-antonio
diff scripts/miscellaneous/mkoctfile.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 |
line wrap: on
line diff
--- a/scripts/miscellaneous/mkoctfile.m Sun May 03 21:52:42 2015 -0700 +++ b/scripts/miscellaneous/mkoctfile.m Mon May 04 14:22:02 2015 -0700 @@ -20,15 +20,15 @@ ## @deftypefn {Command} {} mkoctfile [-options] file @dots{} ## @deftypefnx {Function File} {[@var{output}, @var{status}] =} mkoctfile (@dots{}) ## -## The @code{mkoctfile} function compiles source code written in C, -## C++, or Fortran. Depending on the options used with @code{mkoctfile}, the +## The @code{mkoctfile} function compiles source code written in C, C++, or +## Fortran. Depending on the options used with @code{mkoctfile}, the ## compiled code can be called within Octave or can be used as a stand-alone ## application. ## ## @code{mkoctfile} can be called from the shell prompt or from the Octave -## prompt. Calling it from the Octave prompt simply delegates the -## call to the shell prompt. The output is stored in the @var{output} -## variable and the exit status in the @var{status} variable. +## prompt. Calling it from the Octave prompt simply delegates the call to +## the shell prompt. The output is stored in the @var{output} variable and +## the exit status in the @var{status} variable. ## ## @code{mkoctfile} accepts the following options, all of which are optional ## except for the file name of the code you wish to compile: @@ -69,9 +69,8 @@ ## ## @item -o FILE ## @itemx --output FILE -## Output file name. Default extension is .oct -## (or .mex if @samp{--mex} is specified) unless linking -## a stand-alone executable. +## Output file name. Default extension is .oct (or .mex if @samp{--mex} is +## specified) unless linking a stand-alone executable. ## ## @item -p VAR ## @itemx --print VAR @@ -111,8 +110,8 @@ ## Link a stand-alone executable file. ## ## @item --mex -## Assume we are creating a MEX file. Set the default output extension -## to ".mex". +## Assume we are creating a MEX file. Set the default output extension to +## ".mex". ## ## @item -s ## @itemx --strip