Fcalva/chibi-scheme
1
0
Fork 0
mirror of https://github.com/ashinn/chibi-scheme.git synced 2025-05-21 14:49:18 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating heap-stats docs to use backslash escape.

Browse source
This commit is contained in:
Alex Shinn 2013-08-04 16:56:06 +09:00
parent cb8f50882d
commit 3212f52327
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/chibi/heap-stats.sld
View file

@ -3,20 +3,20 @@
;;> runtime memory usage doesn't give a good idea of how to optimize
;;> that usage, so this module is provided for profiling.
;;> @subsubsubsection{(heap-stats)}
;;> \subsubsubsection{(heap-stats)}
;;> Returns an alist summarizing all heap allocated objects. The
;;> @var{car} of each cell is the type-name, and the @var{cdr} is the
;;> \var{car} of each cell is the type-name, and the \var{cdr} is the
;;> count of objects of that type in the heap. Garbage is collected
;;> before the counts are taken.
;;> @subsubsubsection{(heap-dump [depth])}
;;> \subsubsubsection{(heap-dump [depth])}
;;> Returns the same value as @scheme{(heap-stats)}, but also prints
;;> all objects on the heap as it runs. @var{depth} indicates the
;;> Returns the same value as \scheme{(heap-stats)}, but also prints
;;> all objects on the heap as it runs. \var{depth} indicates the
;;> printing depth for compound objects and defaults to 1.
;;> These functions just return @scheme{'()} when using the Boehm GC.
;;> These functions just return \scheme{'()} when using the Boehm GC.
(define-library (chibi heap-stats)
(export heap-stats heap-dump)