Mercurial > octave-antonio

comparison scripts/miscellaneous/mkoctfile.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 9fc020886ae9
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Command} {} mkoctfile [-options] file @dots{} 20 ## @deftypefn {Command} {} mkoctfile [-options] file @dots{}
21 ## @deftypefnx {Function File} {[@var{output}, @var{status}] =} mkoctfile (@dots{}) 21 ## @deftypefnx {Function File} {[@var{output}, @var{status}] =} mkoctfile (@dots{})
22 ## 22 ##
23 ## The @code{mkoctfile} function compiles source code written in C, 23 ## The @code{mkoctfile} function compiles source code written in C, C++, or
24 ## C++, or Fortran. Depending on the options used with @code{mkoctfile}, the 24 ## Fortran. Depending on the options used with @code{mkoctfile}, the
25 ## compiled code can be called within Octave or can be used as a stand-alone 25 ## compiled code can be called within Octave or can be used as a stand-alone
26 ## application. 26 ## application.
27 ## 27 ##
28 ## @code{mkoctfile} can be called from the shell prompt or from the Octave 28 ## @code{mkoctfile} can be called from the shell prompt or from the Octave
29 ## prompt. Calling it from the Octave prompt simply delegates the 29 ## prompt. Calling it from the Octave prompt simply delegates the call to
30 ## call to the shell prompt. The output is stored in the @var{output} 30 ## the shell prompt. The output is stored in the @var{output} variable and
31 ## variable and the exit status in the @var{status} variable. 31 ## the exit status in the @var{status} variable.
32 ## 32 ##
33 ## @code{mkoctfile} accepts the following options, all of which are optional 33 ## @code{mkoctfile} accepts the following options, all of which are optional
34 ## except for the file name of the code you wish to compile: 34 ## except for the file name of the code you wish to compile:
35 ## 35 ##
36 ## @table @samp 36 ## @table @samp
67 ## @item -g 67 ## @item -g
68 ## Enable debugging options for compilers. 68 ## Enable debugging options for compilers.
69 ## 69 ##
70 ## @item -o FILE 70 ## @item -o FILE
71 ## @itemx --output FILE 71 ## @itemx --output FILE
72 ## Output file name. Default extension is .oct 72 ## Output file name. Default extension is .oct (or .mex if @samp{--mex} is
73 ## (or .mex if @samp{--mex} is specified) unless linking 73 ## specified) unless linking a stand-alone executable.
74 ## a stand-alone executable.
75 ## 74 ##
76 ## @item -p VAR 75 ## @item -p VAR
77 ## @itemx --print VAR 76 ## @itemx --print VAR
78 ## Print the configuration variable VAR@. Recognized variables are: 77 ## Print the configuration variable VAR@. Recognized variables are:
79 ## 78 ##
109 ## 108 ##
110 ## @item --link-stand-alone 109 ## @item --link-stand-alone
111 ## Link a stand-alone executable file. 110 ## Link a stand-alone executable file.
112 ## 111 ##
113 ## @item --mex 112 ## @item --mex
114 ## Assume we are creating a MEX file. Set the default output extension 113 ## Assume we are creating a MEX file. Set the default output extension to
115 ## to ".mex". 114 ## ".mex".
116 ## 115 ##
117 ## @item -s 116 ## @item -s
118 ## @itemx --strip 117 ## @itemx --strip
119 ## Strip the output file. 118 ## Strip the output file.
120 ## 119 ##