Mercurial > octave
changeset 22167:6c94c7bd55e7
doc: Reword methods doc string for clarity
* methods.m: Reword doc string to differentiate between printing and returning
the list of methods. Mention that only public methods are returned. Clarify
that the name of a Java class may be given.
| author | Mike Miller <mtmiller@octave.org> |
|---|---|
| date | Fri, 22 Jul 2016 17:09:38 -0700 |
| parents | 44244c9c177f |
| children | cc731bdc5103 |
| files | scripts/general/methods.m |
| diffstat | 1 files changed, 6 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/general/methods.m Fri Jul 22 17:06:21 2016 -0700 +++ b/scripts/general/methods.m Fri Jul 22 17:09:38 2016 -0700 @@ -20,12 +20,15 @@ ## @deftypefn {} {} methods (@var{obj}) ## @deftypefnx {} {} methods ("@var{classname}") ## @deftypefnx {} {@var{mtds} =} methods (@dots{}) -## -## Return a cell array containing the names of the methods for the -## object @var{obj} or the named class @var{classname}. +## List the names of the public methods for the object @var{obj} or the +## named class @var{classname}. ## ## @var{obj} may be an Octave class object or a Java object. +## @var{classname} may be the name of an Octave class or a Java class. ## +## When called with no output arguments, @code{methods} prints the list of +## method names to the screen. Otherwise, the output argument @var{mtds} +## contains the list in a cell array of strings. ## @seealso{fieldnames} ## @end deftypefn