diff libinterp/octave-value/ov-java.cc @ 15792:12394261da0f

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.
author Rik <rik@octave.org>
date Fri, 14 Dec 2012 13:58:19 -0800
parents 921912c92102
children 492893b98eef
line wrap: on
line diff
--- 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 ();