Mercurial > octave-antonio
comparison scripts/java/java_get.m @ 20160: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 | 4197fc428c7d |
| children |
comparison
equal
deleted
inserted
replaced
| 20159:597991b19e40 | 20160:03b9d17a2d95 |
|---|---|
| 16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {@var{val} =} java_get (@var{obj}, @var{name}) | 20 ## @deftypefn {Function File} {@var{val} =} java_get (@var{obj}, @var{name}) |
| 21 ## Get the value of the field @var{name} of the Java object @var{obj}. For | 21 ## Get the value of the field @var{name} of the Java object @var{obj}. |
| 22 ## static fields, @var{obj} can be a string representing the fully qualified | 22 ## |
| 23 ## name of the corresponding class. | 23 ## For static fields, @var{obj} can be a string representing the fully |
| 24 ## qualified name of the corresponding class. | |
| 24 ## | 25 ## |
| 25 ## When @var{obj} is a regular Java object, structure-like indexing can be | 26 ## When @var{obj} is a regular Java object, structure-like indexing can be |
| 26 ## used as a shortcut syntax. For instance, the two following statements are | 27 ## used as a shortcut syntax. For instance, the following two statements are |
| 27 ## equivalent | 28 ## equivalent |
| 28 ## | 29 ## |
| 29 ## @example | 30 ## @example |
| 30 ## @group | 31 ## @group |
| 31 ## java_get (x, "field1") | 32 ## java_get (x, "field1") |