Mercurial > hg > octave-nkf
diff libinterp/octave-value/ov-java.cc @ 20373:075a5e2e1ba5 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value,
libinterp/parse-tree directories.
* build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc,
libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc,
libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc,
libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc,
libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc,
libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc,
libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll,
libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc,
libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc:
doc: Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 21:52:42 -0700 |
parents | 8187a66039e4 |
children | a9574e3c6e9e 209ee4a730f6 |
line wrap: on
line diff
--- a/libinterp/octave-value/ov-java.cc +++ b/libinterp/octave-value/ov-java.cc @@ -2041,8 +2041,9 @@ DEFUN (__java_init__, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} java_init ()\n\ +@deftypefn {Built-in Function} {} __java_init__ ()\n\ Internal function used @strong{only} when debugging Java interface.\n\ +\n\ Function will directly call initialize_java() to create an instance of a JVM.\n\ @end deftypefn") { @@ -2066,8 +2067,9 @@ DEFUN (__java_exit__, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} java_exit ()\n\ +@deftypefn {Built-in Function} {} __java_exit__ ()\n\ Internal function used @strong{only} when debugging Java interface.\n\ +\n\ Function will directly call terminate_jvm() to destroy the current JVM\n\ instance.\n\ @end deftypefn") @@ -2088,8 +2090,8 @@ 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 below creates an uninitialized object,\n\ -while the second example supplies an initial argument to the constructor.\n\ +The first example below creates an uninitialized object, while the second\n\ +example supplies an initial argument to the constructor.\n\ \n\ @example\n\ @group\n\ @@ -2148,9 +2150,10 @@ @deftypefn {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj})\n\ @deftypefnx {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj}, @var{arg1}, @dots{})\n\ Invoke the method @var{methodname} on the Java object @var{obj} with the\n\ -arguments @var{arg1}, @dots{} For static methods, @var{obj} can be a string\n\ -representing the fully qualified name of the corresponding class. The\n\ -function returns the result of the method invocation.\n\ +arguments @var{arg1}, @dots{}.\n\ +\n\ +For static methods, @var{obj} can be a string representing the fully\n\ +qualified name of the corresponding class.\n\ \n\ When @var{obj} is a regular Java object, structure-like indexing can be\n\ used as a shortcut syntax. For instance, the two following statements are\n\ @@ -2163,6 +2166,8 @@ @end group\n\ @end example\n\ \n\ +@code{javaMethod} returns the result of the method invocation.\n\ +\n\ @seealso{methods, javaObject}\n\ @end deftypefn") { @@ -2222,12 +2227,13 @@ DEFUN (__java_get__, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} __java_get__ (@var{obj}, @var{name})\n\ -Get the value of the field @var{name} of the Java object @var{obj}. For\n\ -static fields, @var{obj} can be a string representing the fully qualified\n\ +Get the value of the field @var{name} of the Java object @var{obj}.\n\ +\n\ +For static fields, @var{obj} can be a string representing the fully qualified\n\ name of the corresponding class.\n\ \n\ -When @var{obj} is a regular Java object, structure-like indexing can be\n\ -used as a shortcut syntax. For instance, the two following statements are\n\ +When @var{obj} is a regular Java object, structure-like indexing can be used\n\ +as a shortcut syntax. For instance, the two following statements are\n\ equivalent\n\ \n\ @example\n\ @@ -2286,8 +2292,10 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{obj} =} __java_set__ (@var{obj}, @var{name}, @var{val})\n\ Set the value of the field @var{name} of the Java object @var{obj} to\n\ -@var{val}. For static fields, @var{obj} can be a string representing the\n\ -fully qualified named of the corresponding Java class.\n\ +@var{val}.\n\ +\n\ +For static fields, @var{obj} can be a string representing the fully\n\ +qualified named of the corresponding Java class.\n\ \n\ When @var{obj} is a regular Java object, structure-like indexing can be\n\ used as a shortcut syntax. For instance, the two following statements are\n\ @@ -2387,10 +2395,12 @@ @deftypefnx {Built-in Function} {@var{old_val} =} java_matrix_autoconversion (@var{new_val})\n\ @deftypefnx {Built-in Function} {} java_matrix_autoconversion (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls whether Java arrays are\n\ -automatically converted to Octave matrices. The default value is false.\n\ +automatically converted to Octave matrices.\n\ +\n\ +The default value is false.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{java_unsigned_autoconversion, debug_java}\n\ @end deftypefn") @@ -2409,12 +2419,13 @@ @deftypefnx {Built-in Function} {@var{old_val} =} java_unsigned_autoconversion (@var{new_val})\n\ @deftypefnx {Built-in Function} {} java_unsigned_autoconversion (@var{new_val}, \"local\")\n\ Query or set the internal variable that controls how integer classes are\n\ -converted when @code{java_matrix_autoconversion} is enabled. When enabled,\n\ -Java arrays of class Byte or Integer are converted to matrices of class\n\ -uint8 or uint32 respectively. The default value is true.\n\ +converted when @code{java_matrix_autoconversion} is enabled.\n\ +\n\ +When enabled, Java arrays of class Byte or Integer are converted to matrices\n\ +of class uint8 or uint32 respectively. The default value is true.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{java_matrix_autoconversion, debug_java}\n\ @end deftypefn") @@ -2437,7 +2448,7 @@ is printed.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @seealso{java_matrix_autoconversion, java_unsigned_autoconversion}\n\ @end deftypefn")