]> git.saurik.com Git - wxWidgets.git/blobdiff - contrib/docs/latex/fl/garbagecollector.tex
corrected version number extraction
[wxWidgets.git] / contrib / docs / latex / fl / garbagecollector.tex
index 2f851e4375a42f9b3dc964da11bb5dc5846bed89..e0f25967b8c41594fbdbc8a147ed395da673da66 100644 (file)
@@ -1,18 +1,22 @@
 %
 % automatically generated by HelpGen $Revision$ from
 %
 % automatically generated by HelpGen $Revision$ from
-% garbagec.h at 05/Jan/02 22:50:57
+% garbagec.h at 21/Jan/02 21:14:19
 %
 
 
 \section{\class{GarbageCollector}}\label{garbagecollector}
 
 
 %
 
 
 \section{\class{GarbageCollector}}\label{garbagecollector}
 
 
-class implements extremely slow, but probably one of the most simple GC algorithms
+This class implements an extremely slow but simple garbage collection algorithm.
 
 \wxheading{Derived from}
 
 No base class
 
 
 \wxheading{Derived from}
 
 No base class
 
+\wxheading{Include files}
+
+<wx/fl/garbagec.h>
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -22,71 +26,89 @@ No base class
 
 \func{}{GarbageCollector}{\void}
 
 
 \func{}{GarbageCollector}{\void}
 
+Default constructor.
+
 
 \membersection{GarbageCollector::\destruct{GarbageCollector}}\label{garbagecollectordtor}
 
 \func{}{\destruct{GarbageCollector}}{\void}
 
 
 \membersection{GarbageCollector::\destruct{GarbageCollector}}\label{garbagecollectordtor}
 
 \func{}{\destruct{GarbageCollector}}{\void}
 
+Destructor.
+
 
 \membersection{GarbageCollector::AddDependency}\label{garbagecollectoradddependency}
 
 \func{void}{AddDependency}{\param{void* }{pObj}, \param{void* }{pDependsOnObj}}
 
 
 \membersection{GarbageCollector::AddDependency}\label{garbagecollectoradddependency}
 
 \func{void}{AddDependency}{\param{void* }{pObj}, \param{void* }{pDependsOnObj}}
 
+Prepare data for garbage collection.
+
 
 \membersection{GarbageCollector::AddObject}\label{garbagecollectoraddobject}
 
 \func{void}{AddObject}{\param{void* }{pObj}, \param{int }{refCnt = 1}}
 
 
 \membersection{GarbageCollector::AddObject}\label{garbagecollectoraddobject}
 
 \func{void}{AddObject}{\param{void* }{pObj}, \param{int }{refCnt = 1}}
 
-prepare data for GC alg.
+Prepare data for garbage collection.
 
 
 \membersection{GarbageCollector::ArrangeCollection}\label{garbagecollectorarrangecollection}
 
 \func{void}{ArrangeCollection}{\void}
 
 
 
 \membersection{GarbageCollector::ArrangeCollection}\label{garbagecollectorarrangecollection}
 
 \func{void}{ArrangeCollection}{\void}
 
-executes GC alg.
+Executes garbage collection algorithm.
 
 
 \membersection{GarbageCollector::DestroyItemList}\label{garbagecollectordestroyitemlist}
 
 \func{void}{DestroyItemList}{\param{wxList\& }{lst}}
 
 
 
 \membersection{GarbageCollector::DestroyItemList}\label{garbagecollectordestroyitemlist}
 
 \func{void}{DestroyItemList}{\param{wxList\& }{lst}}
 
+Destroys a list of items.
+
 
 \membersection{GarbageCollector::FindItemNode}\label{garbagecollectorfinditemnode}
 
 \func{wxNode*}{FindItemNode}{\param{void* }{pForObj}}
 
 
 \membersection{GarbageCollector::FindItemNode}\label{garbagecollectorfinditemnode}
 
 \func{wxNode*}{FindItemNode}{\param{void* }{pForObj}}
 
+Internal method for finding a node.
+
 
 \membersection{GarbageCollector::FindReferenceFreeItemNode}\label{garbagecollectorfindreferencefreeitemnode}
 
 \func{wxNode*}{FindReferenceFreeItemNode}{\void}
 
 
 \membersection{GarbageCollector::FindReferenceFreeItemNode}\label{garbagecollectorfindreferencefreeitemnode}
 
 \func{wxNode*}{FindReferenceFreeItemNode}{\void}
 
+Internal method for findind and freeing a node.
+
 
 \membersection{GarbageCollector::GetCycledObjects}\label{garbagecollectorgetcycledobjects}
 
 \func{wxList\&}{GetCycledObjects}{\void}
 
 
 \membersection{GarbageCollector::GetCycledObjects}\label{garbagecollectorgetcycledobjects}
 
 \func{wxList\&}{GetCycledObjects}{\void}
 
+Get cycled objects.
+
 
 \membersection{GarbageCollector::GetRegularObjects}\label{garbagecollectorgetregularobjects}
 
 \func{wxList\&}{GetRegularObjects}{\void}
 
 
 \membersection{GarbageCollector::GetRegularObjects}\label{garbagecollectorgetregularobjects}
 
 \func{wxList\&}{GetRegularObjects}{\void}
 
-access results of the alg.
+Accesses the results of the algorithm.
 
 
 \membersection{GarbageCollector::RemoveReferencesToNode}\label{garbagecollectorremovereferencestonode}
 
 \func{void}{RemoveReferencesToNode}{\param{wxNode* }{pItemNode}}
 
 
 
 \membersection{GarbageCollector::RemoveReferencesToNode}\label{garbagecollectorremovereferencestonode}
 
 \func{void}{RemoveReferencesToNode}{\param{wxNode* }{pItemNode}}
 
+Remove references to this node.
+
 
 \membersection{GarbageCollector::Reset}\label{garbagecollectorreset}
 
 \func{void}{Reset}{\void}
 
 
 \membersection{GarbageCollector::Reset}\label{garbagecollectorreset}
 
 \func{void}{Reset}{\void}
 
-removes all data from GC
+Removes all data from the garbage collector.
 
 
 \membersection{GarbageCollector::ResolveReferences}\label{garbagecollectorresolvereferences}
 
 \func{void}{ResolveReferences}{\void}
 
 
 
 \membersection{GarbageCollector::ResolveReferences}\label{garbagecollectorresolvereferences}
 
 \func{void}{ResolveReferences}{\void}
 
+Internal method for resolving references.
+