Mercurial > octave-antonio

comparison scripts/java/javachk.m @ 20160:03b9d17a2d95 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 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
comparison
equal deleted inserted replaced
20159:597991b19e40 20160:03b9d17a2d95
37 ## 37 ##
38 ## @item @qcode{"swing"} 38 ## @item @qcode{"swing"}
39 ## Swing components for lightweight GUIs. 39 ## Swing components for lightweight GUIs.
40 ## @end table 40 ## @end table
41 ## 41 ##
42 ## If @var{feature} is supported and: 42 ## If @var{feature} is supported and
43 ## 43 ##
44 ## @itemize @bullet 44 ## @itemize @bullet
45 ## @item 45 ## @item
46 ## No output argument is requested: 46 ## no output argument is requested:
47 ## 47 ##
48 ## Return an empty string 48 ## Return an empty string
49 ## 49 ##
50 ## @item 50 ## @item
51 ## An output argument is requested: 51 ## an output argument is requested:
52 ## 52 ##
53 ## Return a struct with fields @qcode{"feature"} and @qcode{"identifier"} 53 ## Return a struct with fields @qcode{"feature"} and @qcode{"identifier"}
54 ## both empty 54 ## both empty
55 ##
56 ## @end itemize 55 ## @end itemize
57 ## 56 ##
58 ## If @var{feature} is not supported and: 57 ## If @var{feature} is not supported and
59 ## 58 ##
60 ## @itemize @bullet 59 ## @itemize @bullet
61 ## @item 60 ## @item
62 ## No output argument is requested: 61 ## no output argument is requested:
63 ## 62 ##
64 ## Emit an error message. 63 ## Emit an error message
65 ## 64 ##
66 ## @item 65 ## @item
67 ## An output argument is requested: 66 ## an output argument is requested:
68 ## 67 ##
69 ## Return a struct with field @qcode{"feature"} set to @var{feature} and 68 ## Return a struct with field @qcode{"feature"} set to @var{feature} and field
70 ## field @qcode{"identifier"} set to @var{component} 69 ## @qcode{"identifier"} set to @var{component}
71 ##
72 ## @end itemize 70 ## @end itemize
73 ## 71 ##
74 ## The optional input @var{component} will be used in place of @var{feature} 72 ## The optional input @var{component} will be used in place of @var{feature}
75 ## in any error messages for greater specificity. 73 ## in any error messages for greater specificity.
76 ## 74 ##
79 ## their behavior based on the availability of Java. The feature 77 ## their behavior based on the availability of Java. The feature
80 ## @qcode{"desktop"} is never available as Octave has no Java-based desktop. 78 ## @qcode{"desktop"} is never available as Octave has no Java-based desktop.
81 ## Other features may be available if Octave was compiled with the Java 79 ## Other features may be available if Octave was compiled with the Java
82 ## Interface and Java is installed. 80 ## Interface and Java is installed.
83 ## 81 ##
84 ## @seealso{error, usejava} 82 ## @seealso{usejava, error}
85 ## @end deftypefn 83 ## @end deftypefn
86 84
87 ## Author: Philip Nienhuis <prnienhuis at users.sf.net> 85 ## Author: Philip Nienhuis <prnienhuis at users.sf.net>
88 ## Created: 2014-04-19 86 ## Created: 2014-04-19
89 87
90 function msg = javachk (feature, component="") 88 function msg = javachk (feature, component = "")
91 89
92 msg = ""; 90 msg = "";
93 chk = false; 91 chk = false;
94 switch (feature) 92 switch (feature)
95 ## For each feature, try methods() on a Java class of a feature 93 ## For each feature, try methods() on a Java class of a feature