Mercurial > hg > octave-nkf
diff scripts/java/javachk.m @ 20370:03b9d17a2d95 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed io, java, linear-algebra, prefs, and set script directories.
* scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m,
scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m,
scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m,
scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m,
scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m,
scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m,
scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m,
scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m,
scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m,
scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m,
scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m,
scripts/set/powerset.m, scripts/set/setdiff.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 03 May 2015 15:36:23 -0700 |
| parents | 9fc020886ae9 |
| children |
line wrap: on
line diff
--- a/scripts/java/javachk.m +++ b/scripts/java/javachk.m @@ -39,36 +39,34 @@ ## Swing components for lightweight GUIs. ## @end table ## -## If @var{feature} is supported and: +## If @var{feature} is supported and ## ## @itemize @bullet ## @item -## No output argument is requested: +## no output argument is requested: ## ## Return an empty string ## ## @item -## An output argument is requested: +## an output argument is requested: ## ## Return a struct with fields @qcode{"feature"} and @qcode{"identifier"} ## both empty -## ## @end itemize ## -## If @var{feature} is not supported and: +## If @var{feature} is not supported and ## ## @itemize @bullet ## @item -## No output argument is requested: +## no output argument is requested: ## -## Emit an error message. +## Emit an error message ## ## @item -## An output argument is requested: +## an output argument is requested: ## -## Return a struct with field @qcode{"feature"} set to @var{feature} and -## field @qcode{"identifier"} set to @var{component} -## +## Return a struct with field @qcode{"feature"} set to @var{feature} and field +## @qcode{"identifier"} set to @var{component} ## @end itemize ## ## The optional input @var{component} will be used in place of @var{feature} @@ -81,13 +79,13 @@ ## Other features may be available if Octave was compiled with the Java ## Interface and Java is installed. ## -## @seealso{error, usejava} +## @seealso{usejava, error} ## @end deftypefn ## Author: Philip Nienhuis <prnienhuis at users.sf.net> ## Created: 2014-04-19 -function msg = javachk (feature, component="") +function msg = javachk (feature, component = "") msg = ""; chk = false;