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

FPDoc - updates to constructors and destructors in lclclasses.xml and graphics.xml (TFont only)

Browse Source 
git-svn-id: trunk@18289 -
This commit is contained in:
kirkpatc 2009-01-14 19:03:32 +00:00
parent 9371294916
commit ca49a4c70f
2 changed files with 49 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/xml/lcl/graphics.xml
View File

@ -2141,12 +2141,25 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor.
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TFont.Create" link="#rtl.System.TObject.Create">
<descr>Opens a new instance of the class and sets defaults for character set, colour, size etc
<element name="TFont.Create">
<descr>
<var>Create</var> - constructor for TFont: Opens a new instance of the class and sets defaults for character set, colour, size etc
</descr>
<short>
<var>Create</var> - constructor for TFont: Opens a new instance of the class</short>
<seealso>
<link id="#rtl.System.TObject.Create"/>
</seealso>
</element>
<!-- destructor Visibility: public -->
<element name="TFont.Destroy" link="#rtl.Classes.TPersistent.Destroy"/>
<element name="TFont.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TFont</var>: frees reference then performs inherited <var>Destroy</var>
</short>
<seealso>
<link id="#rtl.Classes.TPersistent.Destroy"/>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TFont.Assign" link="#rtl.Classes.TPersistent.Assign">
<descr>

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

@ -44,17 +44,23 @@
</element>
<!-- procedure Visibility: public -->
<element name="TLCLComponent.BeforeDestruction">
<short/>
<short>
<var>BeforeDestruction</var> - code to execute before destruction of Control: performs inherited <var>Destroying</var> method</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroying"/>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TLCLComponent.NewInstance">
<short/>
<short>
<var>NewInstance</var> - performs inherited <var>NewInstance</var> to allocate space on the heap, and loads the correct WidgetSet</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TObject.NewInstance"/>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLCLComponent.NewInstance.Result">
@ -72,13 +78,17 @@
<element name="TLCLComponent.RemoveAllHandlersOfObject.AnObject">
<short/>
</element>
<element name="TLCLComponent.Create"/>
<element name="TLCLComponent.Destroy"/>
<element name="TLCLComponent.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TLCLComponent.Destroy" link="#rtl.Classes.TComponent.Destroy"/>
<element name="TLCLReferenceComponent">
<short>
<var>TLCLReferenceComponent</var> - A base class for all components having a handle</short>
</element>
<element name="TLCLReferenceComponent.Destroy"/>
<element name="TLCLReferenceComponent.Destroy">
<short>
<var>Destroy</var> the reference, then perform inherited <var>Destroy</var>
</short>
</element>
<element name="TLCLReferenceComponent.Handle">
<short>
<var>Handle</var> a handle (sort of pointer or reference) allocated by the operating system to this component</short>
@ -91,6 +101,22 @@
<short>
<var>ReferenceAllocated</var> - if True, a handle (reference) has been allocated to this component</short>
</element>
<element name="TLCLReferenceComponent.CreateParams">
<short>
<var>CreateParams</var> - create parameters</short>
</element>
<element name="TLCLReferenceComponent.GetReferenceHandle"/>
<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>
</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>
</module>
<!-- LCLClasses -->
</package>