Mercurial > octave

changeset 22166:44244c9c177f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Reword and clarify fieldnames doc string for Java classes and objects * fieldnames.m: Reword and clarify doc string for Java classes and objects.
author Mike Miller <mtmiller@octave.org>
date Fri, 22 Jul 2016 17:06:21 -0700
parents 20e684ec108e
children 6c94c7bd55e7
files scripts/general/fieldnames.m
diffstat 1 files changed, 4 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/general/fieldnames.m	Fri Jul 22 15:26:58 2016 -0400
+++ b/scripts/general/fieldnames.m	Fri Jul 22 17:06:21 2016 -0700
@@ -20,7 +20,7 @@
 ## @deftypefn  {} {@var{names} =} fieldnames (@var{struct})
 ## @deftypefnx {} {@var{names} =} fieldnames (@var{obj})
 ## @deftypefnx {} {@var{names} =} fieldnames (@var{javaobj})
-## @deftypefnx {} {@var{names} =} fieldnames ("@var{jclassname}")
+## @deftypefnx {} {@var{names} =} fieldnames ("@var{javaclassname}")
 ## Return a cell array of strings with the names of the fields in the
 ## specified input.
 ##
@@ -30,9 +30,9 @@
 ## When the input is an Octave object @var{obj}, the names are the public
 ## properties of the object.
 ##
-## When the input is a Java object @var{javaobj} or Java classname
-## @var{jclassname} the name are the public data elements of the object or
-## class.
+## When the input is a Java object @var{javaobj} or a string containing the
+## name of a Java class @var{javaclassname}, the names are the public fields
+## (data members) of the object or class.
 ## @seealso{numfields, isfield, orderfields, struct, methods}
 ## @end deftypefn