comparison scripts/java/javamem.m @ 16392:801297f14e4b

doc: Improve documentation for Java chapter and java functions. * doc/interpreter/java.txi, scripts/java/javamem.m, scripts/java/listdlg.m, scripts/java/msgbox.m, scripts/java/questdlg.m: Improve documentation for Java chapter and java functions.
author Rik <rik@octave.org>
date Fri, 29 Mar 2013 12:05:45 -0700
parents 93516992ee34
children 12005245b645
comparison
equal deleted inserted replaced
16391:a695ee2dc17e 16392:801297f14e4b
29 ## All Java-based routines are run in the JVM's shared memory pool, 29 ## All Java-based routines are run in the JVM's shared memory pool,
30 ## a dedicated and separate part of memory claimed by the JVM from 30 ## a dedicated and separate part of memory claimed by the JVM from
31 ## your computer's total memory (which comprises physical RAM and 31 ## your computer's total memory (which comprises physical RAM and
32 ## virtual memory / swap space on hard disk). 32 ## virtual memory / swap space on hard disk).
33 ## 33 ##
34 ## The maximum allowable memory usage can be set using the file java.opts 34 ## The maximum allowable memory usage can be configured using the file
35 ## (in the same subdirectory where javaaddpath.m lives, see 35 ## @file{java.opts}. The directory where this file resides is
36 ## "which javaaddpath". Usually that is: 36 ## determined by the environment variable @w{@env{OCTAVE_JAVA_DIR}}.
37 ## If unset, the directory where @file{javaaddpath.m} resides is used instead
38 ## (typically @file{@env{OCTAVE_HOME}/share/octave/@env{OCTAVE_VERSION}/m/java/}
37 ## 39 ##
38 ## @file{OCTAVE_HOME/share/octave/OCTAVE_VERSION/m/java/} 40 ## @file{java.opts} is a plain text file with one option per line. The
39 ##
40 ## java.opts is a plain text file with one option per line. The
41 ## default initial memory size and default maximum memory size (which 41 ## default initial memory size and default maximum memory size (which
42 ## are both system dependent) can be overridden like so: 42 ## are both system dependent) can be overridden like so:
43 ## 43 ##
44 ## @nospell{-Xms64m} 44 ## @nospell{-Xms64m}
45 ## 45 ##
46 ## @nospell{-Xmx512m} 46 ## @nospell{-Xmx512m}
47 ## 47 ##
48 ## (in megabytes in this example.) 48 ## (in megabytes in this example).
49 ## You can adapt these values to your own requirements if your system 49 ## You can adapt these values to your own requirements if your system
50 ## has limited available physical memory or if you get Java memory 50 ## has limited available physical memory or if you get Java memory
51 ## errors. 51 ## errors.
52 ## 52 ##
53 ## "Total memory" is what the operating system has currently assigned 53 ## "Total memory" is what the operating system has currently assigned