# HG changeset patch # User Rik # Date 1355522299 28800 # Node ID 12394261da0fbd81a404c684644f419c8ba8f470 # Parent 49f5962fa20d1aaca4f936395daa0bc2ac330e72 doc: tweak docstrings for javaObject and javaArray. * libinterp/octave-value/ov-java.cc: Improve docstring. Add seealso to javaArray. * scripts/java/javaArray.m: Improve docstring. Add seealso to javaObject. diff -r 49f5962fa20d -r 12394261da0f libinterp/octave-value/ov-java.cc --- a/libinterp/octave-value/ov-java.cc Fri Dec 14 12:15:47 2012 -0800 +++ b/libinterp/octave-value/ov-java.cc Fri Dec 14 13:58:19 2012 -0800 @@ -1875,22 +1875,22 @@ DEFUN (javaObject, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{obj} =} javaObject (@var{classname})\n\ -@deftypefnx {Built-in Function} {@var{obj} =} javaObject (@var{classname}, @var{arg1}, @dots{})\n\ +@deftypefn {Built-in Function} {@var{jobj} =} javaObject (@var{classname})\n\ +@deftypefnx {Built-in Function} {@var{jobj} =} javaObject (@var{classname}, @var{arg1}, @dots{})\n\ Create a Java object of class @var{classsname}, by calling the class\n\ constructor with the arguments @var{arg1}, @dots{}\n\ \n\ -The first example creates an uninitialized object, \\n\ -while the second example supplies an initializer argument.\n\ +The first example creates an uninitialized object,\n\ +while the second example supplies an initial argument to the constructor.\n\ \n\ @example\n\ @group\n\ - x = javaObject (\"java.lang.StringBuffer\")\n\ - x = javaObject (\"java.lang.StringBuffer\", \"Initial string\")\n\ +x = javaObject (\"java.lang.StringBuffer\")\n\ +x = javaObject (\"java.lang.StringBuffer\", \"Initial string\")\n\ @end group\n\ @end example\n\ \n\ -@seealso{javaMethod}\n\ +@seealso{javaMethod, javaArray}\n\ @end deftypefn") { #ifdef HAVE_JAVA @@ -1913,7 +1913,7 @@ retval = octave_java::do_javaObject (current_env, classname, tmp); } else - error ("javaObject: CLASSNAME argument must be a string"); + error ("javaObject: CLASSNAME must be a string"); } else print_usage (); diff -r 49f5962fa20d -r 12394261da0f scripts/java/javaArray.m --- a/scripts/java/javaArray.m Fri Dec 14 12:15:47 2012 -0800 +++ b/scripts/java/javaArray.m Fri Dec 14 13:58:19 2012 -0800 @@ -17,8 +17,8 @@ ## . ## -*- texinfo -*- -## @deftypefn {Function File} {@var{a} =} javaArray (@var{classname}, @var{sz}) -## @deftypefnx {Function File} {@var{a} =} javaArray (@var{classname}, @var{m}, @var{n}, @dots{}) +## @deftypefn {Function File} {@var{jary} =} javaArray (@var{classname}, @var{sz}) +## @deftypefnx {Function File} {@var{jary} =} javaArray (@var{classname}, @var{m}, @var{n}, @dots{}) ## ## Create a Java array of size @var{sz} with elements of class ## @var{classname}. @var{classname} may be a Java object representing a class @@ -32,10 +32,11 @@ ## ## @example ## @group -## a = javaArray ("java.lang.String", 2, 2); -## a(1,1) = "Hello"; +## jary = javaArray ("java.lang.String", 2, 2); +## jary(1,1) = "Hello"; ## @end group ## @end example +## @seealso{javaObject} ## @end deftypefn function retval = javaArray (classname, varargin)