Mercurial > hg > octave-nkf

comparison libinterp/octave-value/ov-java.cc @ 20373:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20372:2645f9ef8c88 20373:075a5e2e1ba5
2039 // DEFUN blocks below must be outside of HAVE_JAVA block so that 2039 // DEFUN blocks below must be outside of HAVE_JAVA block so that
2040 // documentation strings are always available, even when functions are not. 2040 // documentation strings are always available, even when functions are not.
2041 2041
2042 DEFUN (__java_init__, , , 2042 DEFUN (__java_init__, , ,
2043 "-*- texinfo -*-\n\ 2043 "-*- texinfo -*-\n\
2044 @deftypefn {Built-in Function} {} java_init ()\n\ 2044 @deftypefn {Built-in Function} {} __java_init__ ()\n\
2045 Internal function used @strong{only} when debugging Java interface.\n\ 2045 Internal function used @strong{only} when debugging Java interface.\n\
2046 \n\
2046 Function will directly call initialize_java() to create an instance of a JVM.\n\ 2047 Function will directly call initialize_java() to create an instance of a JVM.\n\
2047 @end deftypefn") 2048 @end deftypefn")
2048 { 2049 {
2049 2050
2050 #ifdef HAVE_JAVA 2051 #ifdef HAVE_JAVA
2064 #endif 2065 #endif
2065 } 2066 }
2066 2067
2067 DEFUN (__java_exit__, , , 2068 DEFUN (__java_exit__, , ,
2068 "-*- texinfo -*-\n\ 2069 "-*- texinfo -*-\n\
2069 @deftypefn {Built-in Function} {} java_exit ()\n\ 2070 @deftypefn {Built-in Function} {} __java_exit__ ()\n\
2070 Internal function used @strong{only} when debugging Java interface.\n\ 2071 Internal function used @strong{only} when debugging Java interface.\n\
2072 \n\
2071 Function will directly call terminate_jvm() to destroy the current JVM\n\ 2073 Function will directly call terminate_jvm() to destroy the current JVM\n\
2072 instance.\n\ 2074 instance.\n\
2073 @end deftypefn") 2075 @end deftypefn")
2074 { 2076 {
2075 #ifdef HAVE_JAVA 2077 #ifdef HAVE_JAVA
2086 @deftypefn {Built-in Function} {@var{jobj} =} javaObject (@var{classname})\n\ 2088 @deftypefn {Built-in Function} {@var{jobj} =} javaObject (@var{classname})\n\
2087 @deftypefnx {Built-in Function} {@var{jobj} =} javaObject (@var{classname}, @var{arg1}, @dots{})\n\ 2089 @deftypefnx {Built-in Function} {@var{jobj} =} javaObject (@var{classname}, @var{arg1}, @dots{})\n\
2088 Create a Java object of class @var{classsname}, by calling the class\n\ 2090 Create a Java object of class @var{classsname}, by calling the class\n\
2089 constructor with the arguments @var{arg1}, @dots{}\n\ 2091 constructor with the arguments @var{arg1}, @dots{}\n\
2090 \n\ 2092 \n\
2091 The first example below creates an uninitialized object,\n\ 2093 The first example below creates an uninitialized object, while the second\n\
2092 while the second example supplies an initial argument to the constructor.\n\ 2094 example supplies an initial argument to the constructor.\n\
2093 \n\ 2095 \n\
2094 @example\n\ 2096 @example\n\
2095 @group\n\ 2097 @group\n\
2096 x = javaObject (\"java.lang.StringBuffer\")\n\ 2098 x = javaObject (\"java.lang.StringBuffer\")\n\
2097 x = javaObject (\"java.lang.StringBuffer\", \"Initial string\")\n\ 2099 x = javaObject (\"java.lang.StringBuffer\", \"Initial string\")\n\
2146 DEFUN (javaMethod, args, , 2148 DEFUN (javaMethod, args, ,
2147 "-*- texinfo -*-\n\ 2149 "-*- texinfo -*-\n\
2148 @deftypefn {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj})\n\ 2150 @deftypefn {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj})\n\
2149 @deftypefnx {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj}, @var{arg1}, @dots{})\n\ 2151 @deftypefnx {Built-in Function} {@var{ret} =} javaMethod (@var{methodname}, @var{obj}, @var{arg1}, @dots{})\n\
2150 Invoke the method @var{methodname} on the Java object @var{obj} with the\n\ 2152 Invoke the method @var{methodname} on the Java object @var{obj} with the\n\
2151 arguments @var{arg1}, @dots{} For static methods, @var{obj} can be a string\n\ 2153 arguments @var{arg1}, @dots{}.\n\
2152 representing the fully qualified name of the corresponding class. The\n\ 2154 \n\
2153 function returns the result of the method invocation.\n\ 2155 For static methods, @var{obj} can be a string representing the fully\n\
2156 qualified name of the corresponding class.\n\
2154 \n\ 2157 \n\
2155 When @var{obj} is a regular Java object, structure-like indexing can be\n\ 2158 When @var{obj} is a regular Java object, structure-like indexing can be\n\
2156 used as a shortcut syntax. For instance, the two following statements are\n\ 2159 used as a shortcut syntax. For instance, the two following statements are\n\
2157 equivalent\n\ 2160 equivalent\n\
2158 \n\ 2161 \n\
2160 @group\n\ 2163 @group\n\
2161 ret = javaMethod (\"method1\", x, 1.0, \"a string\")\n\ 2164 ret = javaMethod (\"method1\", x, 1.0, \"a string\")\n\
2162 ret = x.method1 (1.0, \"a string\")\n\ 2165 ret = x.method1 (1.0, \"a string\")\n\
2163 @end group\n\ 2166 @end group\n\
2164 @end example\n\ 2167 @end example\n\
2168 \n\
2169 @code{javaMethod} returns the result of the method invocation.\n\
2165 \n\ 2170 \n\
2166 @seealso{methods, javaObject}\n\ 2171 @seealso{methods, javaObject}\n\
2167 @end deftypefn") 2172 @end deftypefn")
2168 { 2173 {
2169 #ifdef HAVE_JAVA 2174 #ifdef HAVE_JAVA
2220 */ 2225 */
2221 2226
2222 DEFUN (__java_get__, args, , 2227 DEFUN (__java_get__, args, ,
2223 "-*- texinfo -*-\n\ 2228 "-*- texinfo -*-\n\
2224 @deftypefn {Built-in Function} {@var{val} =} __java_get__ (@var{obj}, @var{name})\n\ 2229 @deftypefn {Built-in Function} {@var{val} =} __java_get__ (@var{obj}, @var{name})\n\
2225 Get the value of the field @var{name} of the Java object @var{obj}. For\n\ 2230 Get the value of the field @var{name} of the Java object @var{obj}.\n\
2226 static fields, @var{obj} can be a string representing the fully qualified\n\ 2231 \n\
2232 For static fields, @var{obj} can be a string representing the fully qualified\n\
2227 name of the corresponding class.\n\ 2233 name of the corresponding class.\n\
2228 \n\ 2234 \n\
2229 When @var{obj} is a regular Java object, structure-like indexing can be\n\ 2235 When @var{obj} is a regular Java object, structure-like indexing can be used\n\
2230 used as a shortcut syntax. For instance, the two following statements are\n\ 2236 as a shortcut syntax. For instance, the two following statements are\n\
2231 equivalent\n\ 2237 equivalent\n\
2232 \n\ 2238 \n\
2233 @example\n\ 2239 @example\n\
2234 @group\n\ 2240 @group\n\
2235 __java_get__ (x, \"field1\")\n\ 2241 __java_get__ (x, \"field1\")\n\
2284 2290
2285 DEFUN (__java_set__, args, , 2291 DEFUN (__java_set__, args, ,
2286 "-*- texinfo -*-\n\ 2292 "-*- texinfo -*-\n\
2287 @deftypefn {Built-in Function} {@var{obj} =} __java_set__ (@var{obj}, @var{name}, @var{val})\n\ 2293 @deftypefn {Built-in Function} {@var{obj} =} __java_set__ (@var{obj}, @var{name}, @var{val})\n\
2288 Set the value of the field @var{name} of the Java object @var{obj} to\n\ 2294 Set the value of the field @var{name} of the Java object @var{obj} to\n\
2289 @var{val}. For static fields, @var{obj} can be a string representing the\n\ 2295 @var{val}.\n\
2290 fully qualified named of the corresponding Java class.\n\ 2296 \n\
2297 For static fields, @var{obj} can be a string representing the fully\n\
2298 qualified named of the corresponding Java class.\n\
2291 \n\ 2299 \n\
2292 When @var{obj} is a regular Java object, structure-like indexing can be\n\ 2300 When @var{obj} is a regular Java object, structure-like indexing can be\n\
2293 used as a shortcut syntax. For instance, the two following statements are\n\ 2301 used as a shortcut syntax. For instance, the two following statements are\n\
2294 equivalent\n\ 2302 equivalent\n\
2295 \n\ 2303 \n\
2385 "-*- texinfo -*-\n\ 2393 "-*- texinfo -*-\n\
2386 @deftypefn {Built-in Function} {@var{val} =} java_matrix_autoconversion ()\n\ 2394 @deftypefn {Built-in Function} {@var{val} =} java_matrix_autoconversion ()\n\
2387 @deftypefnx {Built-in Function} {@var{old_val} =} java_matrix_autoconversion (@var{new_val})\n\ 2395 @deftypefnx {Built-in Function} {@var{old_val} =} java_matrix_autoconversion (@var{new_val})\n\
2388 @deftypefnx {Built-in Function} {} java_matrix_autoconversion (@var{new_val}, \"local\")\n\ 2396 @deftypefnx {Built-in Function} {} java_matrix_autoconversion (@var{new_val}, \"local\")\n\
2389 Query or set the internal variable that controls whether Java arrays are\n\ 2397 Query or set the internal variable that controls whether Java arrays are\n\
2390 automatically converted to Octave matrices. The default value is false.\n\ 2398 automatically converted to Octave matrices.\n\
2399 \n\
2400 The default value is false.\n\
2391 \n\ 2401 \n\
2392 When called from inside a function with the @qcode{\"local\"} option, the\n\ 2402 When called from inside a function with the @qcode{\"local\"} option, the\n\
2393 variable is changed locally for the function and any subroutines it calls. \n\ 2403 variable is changed locally for the function and any subroutines it calls.\n\
2394 The original variable value is restored when exiting the function.\n\ 2404 The original variable value is restored when exiting the function.\n\
2395 @seealso{java_unsigned_autoconversion, debug_java}\n\ 2405 @seealso{java_unsigned_autoconversion, debug_java}\n\
2396 @end deftypefn") 2406 @end deftypefn")
2397 { 2407 {
2398 #ifdef HAVE_JAVA 2408 #ifdef HAVE_JAVA
2407 "-*- texinfo -*-\n\ 2417 "-*- texinfo -*-\n\
2408 @deftypefn {Built-in Function} {@var{val} =} java_unsigned_autoconversion ()\n\ 2418 @deftypefn {Built-in Function} {@var{val} =} java_unsigned_autoconversion ()\n\
2409 @deftypefnx {Built-in Function} {@var{old_val} =} java_unsigned_autoconversion (@var{new_val})\n\ 2419 @deftypefnx {Built-in Function} {@var{old_val} =} java_unsigned_autoconversion (@var{new_val})\n\
2410 @deftypefnx {Built-in Function} {} java_unsigned_autoconversion (@var{new_val}, \"local\")\n\ 2420 @deftypefnx {Built-in Function} {} java_unsigned_autoconversion (@var{new_val}, \"local\")\n\
2411 Query or set the internal variable that controls how integer classes are\n\ 2421 Query or set the internal variable that controls how integer classes are\n\
2412 converted when @code{java_matrix_autoconversion} is enabled. When enabled,\n\ 2422 converted when @code{java_matrix_autoconversion} is enabled.\n\
2413 Java arrays of class Byte or Integer are converted to matrices of class\n\ 2423 \n\
2414 uint8 or uint32 respectively. The default value is true.\n\ 2424 When enabled, Java arrays of class Byte or Integer are converted to matrices\n\
2425 of class uint8 or uint32 respectively. The default value is true.\n\
2415 \n\ 2426 \n\
2416 When called from inside a function with the @qcode{\"local\"} option, the\n\ 2427 When called from inside a function with the @qcode{\"local\"} option, the\n\
2417 variable is changed locally for the function and any subroutines it calls. \n\ 2428 variable is changed locally for the function and any subroutines it calls.\n\
2418 The original variable value is restored when exiting the function.\n\ 2429 The original variable value is restored when exiting the function.\n\
2419 @seealso{java_matrix_autoconversion, debug_java}\n\ 2430 @seealso{java_matrix_autoconversion, debug_java}\n\
2420 @end deftypefn") 2431 @end deftypefn")
2421 { 2432 {
2422 #ifdef HAVE_JAVA 2433 #ifdef HAVE_JAVA
2435 Query or set the internal variable that determines whether extra debugging\n\ 2446 Query or set the internal variable that determines whether extra debugging\n\
2436 information regarding the initialization of the JVM and any Java exceptions\n\ 2447 information regarding the initialization of the JVM and any Java exceptions\n\
2437 is printed.\n\ 2448 is printed.\n\
2438 \n\ 2449 \n\
2439 When called from inside a function with the @qcode{\"local\"} option, the\n\ 2450 When called from inside a function with the @qcode{\"local\"} option, the\n\
2440 variable is changed locally for the function and any subroutines it calls. \n\ 2451 variable is changed locally for the function and any subroutines it calls.\n\
2441 The original variable value is restored when exiting the function.\n\ 2452 The original variable value is restored when exiting the function.\n\
2442 @seealso{java_matrix_autoconversion, java_unsigned_autoconversion}\n\ 2453 @seealso{java_matrix_autoconversion, java_unsigned_autoconversion}\n\
2443 @end deftypefn") 2454 @end deftypefn")
2444 { 2455 {
2445 #ifdef HAVE_JAVA 2456 #ifdef HAVE_JAVA