Tidied/commented FL header files, regenerated docs and filled out Category section.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@13738 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2002-01-21 22:34:42 +00:00
parent 293a0a8677
commit 4cbc57f086
108 changed files with 7384 additions and 5199 deletions

View File

@@ -1,18 +1,22 @@
%
% 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}
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{Include files}
<garbagec.h>
\wxheading{Data structures}
\latexignore{\rtfignore{\wxheading{Members}}}
@@ -22,71 +26,89 @@ No base class
\func{}{GarbageCollector}{\void}
Default constructor.
\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}}
Prepare data for garbage collection.
\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}
executes GC alg.
Executes garbage collection algorithm.
\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}}
Internal method for finding a node.
\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}
Get cycled objects.
\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}}
Remove references to this node.
\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}
Internal method for resolving references.