Mercurial > octave-antonio
diff scripts/java/javamem.m @ 20160:03b9d17a2d95 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed io, java, linear-algebra, prefs, and set script directories.
* scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m,
scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m,
scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m,
scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m,
scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m,
scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m,
scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m,
scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m,
scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m,
scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m,
scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m,
scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m,
scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m,
scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m,
scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m,
scripts/set/powerset.m, scripts/set/setdiff.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 15:36:23 -0700 |
parents | 0e1f5a750d00 |
children |
line wrap: on
line diff
--- a/scripts/java/javamem.m Sun May 03 12:58:42 2015 -0700 +++ b/scripts/java/javamem.m Sun May 03 15:36:23 2015 -0700 @@ -19,44 +19,41 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} javamem () ## @deftypefnx {Function File} {@var{jmem} =} javamem () -## Show the current memory usage of the Java virtual machine (JVM) -## and run the garbage collector. +## Show the current memory usage of the Java virtual machine (JVM) and run the +## garbage collector. ## ## When no return argument is given the info is printed to the screen. -## Otherwise, the output cell array @var{jmem} contains Maximum, Total, -## and Free memory (in bytes). +## Otherwise, the output cell array @var{jmem} contains Maximum, Total, and +## Free memory (in bytes). ## -## All Java-based routines are run in the JVM's shared memory pool, -## a dedicated and separate part of memory claimed by the JVM from -## your computer's total memory (which comprises physical RAM and -## virtual memory / swap space on hard disk). +## All Java-based routines are run in the JVM's shared memory pool, a +## dedicated and separate part of memory claimed by the JVM from your +## computer's total memory (which comprises physical RAM and virtual memory / +## swap space on hard disk). ## ## The maximum allowable memory usage can be configured using the file -## @file{java.opts}. The directory where this file resides is -## determined by the environment variable @w{@env{OCTAVE_JAVA_DIR}}. -## If unset, the directory where @file{javaaddpath.m} resides is used instead -## (typically +## @file{java.opts}. The directory where this file resides is determined by +## the environment variable @w{@env{OCTAVE_JAVA_DIR}}. If unset, the directory +## where @file{javaaddpath.m} resides is used instead (typically ## @file{@w{@env{OCTAVE_HOME}}/share/octave/@w{@env{OCTAVE_VERSION}}/m/java/}). ## -## @file{java.opts} is a plain text file with one option per line. The -## default initial memory size and default maximum memory size (which -## are both system dependent) can be overridden like so: +## @file{java.opts} is a plain text file with one option per line. The default +## initial memory size and default maximum memory size (which are both system +## dependent) can be overridden like so: ## ## @nospell{-Xms64m} ## ## @nospell{-Xmx512m} ## ## (in megabytes in this example). -## You can adapt these values to your own requirements if your system -## has limited available physical memory or if you get Java memory -## errors. +## You can adapt these values to your own requirements if your system has +## limited available physical memory or if you get Java memory errors. ## -## "Total memory" is what the operating system has currently assigned -## to the JVM and depends on actual and active memory usage. -## "Free memory" is self-explanatory. During operation of Java-based -## Octave functions the amount of Total and Free memory will vary, -## due to Java's own cleaning up and your operating system's memory -## management. +## @qcode{"Total memory"} is what the operating system has currently assigned +## to the JVM and depends on actual and active memory usage. +## @qcode{"Free memory"} is self-explanatory. During operation of Java-based +## Octave functions the amount of Total and Free memory will vary, due to +## Java's own cleaning up and your operating system's memory management. ## @end deftypefn ## Author: Philip Nienhuis