# HG changeset patch # User Ernst Reissnere # Date 1469145513 -7200 # Fri Jul 22 01:58:33 2016 +0200 # Node ID bd66ce24a0f1b1b799d0c68a7a3ecfe68843a182 # Parent 8e81840a23e4548d7aa3d2e90ceb185e517ab44e improved documentation. diff -r 8e81840a23e4 -r bd66ce24a0f1 scripts/general/fieldnames.m --- a/scripts/general/fieldnames.m Wed Jul 20 15:15:20 2016 +0200 +++ b/scripts/general/fieldnames.m Fri Jul 22 01:58:33 2016 +0200 @@ -19,20 +19,22 @@ ## -*- texinfo -*- ## @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{javaObj}) +## @deftypefnx {} {@var{names} =} fieldnames (@var{javaClassname}) +## ## Return a cell array of strings with the names of the fields in the ## specified input. ## -## When the input is a structure @var{struct}, the names are the elements of +## If the input is a structure @var{struct}, the names are the elements of ## the structure. ## -## When the input is an Octave object @var{obj}, the names are the public -## properties of the object. +## If the input is an Octave object @var{obj}, +## then @var{names} lists the public fields 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. +## If the input is a Java object @var{javaObj} +## or Java classname @var{javaClassname}, +## then @var{names} lists the public fields of the object or class. +## ## @seealso{numfields, isfield, orderfields, struct, methods} ## @end deftypefn @@ -43,7 +45,7 @@ endif if (isstruct (obj) || isobject (obj)) - ## Call internal C++ function for structs or Octave objects + ## Call internal C++ function for structs and Octave objects names = __fieldnames__ (obj); elseif (isjava (obj) || ischar (obj)) ## FIXME: Function prototype that excepts java obj exists, but doesn't diff -r 8e81840a23e4 -r bd66ce24a0f1 scripts/general/methods.m --- a/scripts/general/methods.m Wed Jul 20 15:15:20 2016 +0200 +++ b/scripts/general/methods.m Fri Jul 22 01:58:33 2016 +0200 @@ -17,14 +17,21 @@ ## . ## -*- texinfo -*- -## @deftypefn {} {} methods (@var{obj}) -## @deftypefnx {} {} methods ("@var{classname}") -## @deftypefnx {} {@var{mtds} =} methods (@dots{}) +## @deftypefn {} {@var{mtds} =} methods (@var{obj}) +## @deftypefnx {} {@var{mtds} =} methods (@var{classname}) +## @deftypefn {} {@var{mtds} =} methods (@var{javaObj}) +## @deftypefnx {} {@var{mtds} =} methods (@var{javaClassname}) ## -## Return a cell array containing the names of the methods for the -## object @var{obj} or the named class @var{classname}. +## Return a cell array containing the names of the public methods +## of the specified input. ## -## @var{obj} may be an Octave class object or a Java object. +## If the input is an Octave object @var{obj} +## or the name of an Octave class @var{classname}, +## then @var{mtds} lists the public methods of the object or class. +## +## If the input is a Java object @var{javaObj} +## or the name of an Octave class @var{javaClassname}, +## then @var{mtds} lists the public methods of the object or class. ## ## @seealso{fieldnames} ## @end deftypefn