paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-21 14:39:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - additional descriptions for classes in LCLClasses.xml; minor change in dbgrids.xml

Browse Source 
git-svn-id: trunk@18668 -
This commit is contained in:
kirkpatc 2009-02-13 19:12:52 +00:00
parent a3b8501d07
commit 02251dc4d6
2 changed files with 48 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/xml/lcl/dbgrids.xml
View File

@ -674,7 +674,7 @@
<!-- object Visibility: default -->
<element name="TComponentDataLink">
<short>
<var>TComponentDataLink</var> - </short>
<var>TComponentDataLink</var> - forms a link between a component and a DataSet and contains event handlers to operate on the records</short>
<descr/>
<errors/>
<seealso/>

51
docs/xml/lcl/lclclasses.xml
View File

@ -78,8 +78,22 @@
<element name="TLCLComponent.RemoveAllHandlersOfObject.AnObject">
<short/>
</element>
<element name="TLCLComponent.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TLCLComponent.Destroy" link="#rtl.Classes.TComponent.Destroy"/>
<element name="TLCLComponent.Create">
<short>
<var>Create</var> - constructor for <var>TLCLComponent</var>: calls inherited <var>Create</var>
</short>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<element name="TLCLComponent.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TLCLComponent</var>: calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
</seealso>
</element>
<element name="TLCLReferenceComponent">
<short>
<var>TLCLReferenceComponent</var> - A base class for all components having a handle</short>
@ -105,18 +119,47 @@
<short>
<var>CreateParams</var> - create parameters</short>
</element>
<element name="TLCLReferenceComponent.GetReferenceHandle"/>
<element name="TLCLReferenceComponent.GetReferenceHandle">
<short>
<var>GetReferenceHandle</var> - returns the Handle for this reference</short>
</element>
<element name="TLCLReferenceComponent.DestroyReference">
<short>
<var>DestroyReference</var> - destroys the reference if it has been allocated and adjusts the pointers</short>
</element>
<element name="TLCLReferenceComponent.ReferenceDestroying">
<short>
<var>ReferenceDestroying</var> - the reference is being destroyed</short>
<var>ReferenceDestroying</var> - the reference is being destroyed; gets called before the Handle is destroyed</short>
</element>
<element name="TLCLReferenceComponent.ReferenceNeeded">
<short>If <var>ReferenceNeeded</var> and not yet allocated, creates a reference using the correct widgetset and parameters</short>
</element>
<element name="TLCLComponent.IncLCLRefCount">
<short>
<var>IncLCLRefCount</var> - method for incrementing the reference count</short>
</element>
<element name="TLCLComponent.DecLCLRefCount">
<short>
<var>DecLCLRefCount</var> - method for decrementing the reference count</short>
</element>
<element name="TLCLComponent.LCLRefCount">
<short>
<var>LCLRefCount</var> - the number of references to this component</short>
</element>
<element name="TLCLReferenceComponent.ReferenceCreated">
<short>
<var>ReferenceCreated</var> - gets called after the Handle is created</short>
</element>
<element name="TLCLReferenceComponent.WSCreateReference">
<short>
<var>WSCreateReference</var> - returns a widget set reference</short>
<descr>this function returns nil and should be overriden in derrived class
</descr>
</element>
<element name="TLCLReferenceComponent.WSDestroyReference">
<short>
<var>WSDestroyReference</var> - destroys widget set reference</short>
</element>
</module>
<!-- LCLClasses -->
</package>