paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-10-03 01:59:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - fixes to constructors and destructors, and some corrections, in buttons.xml, calendar.xml, chart.xml, checklst.xml, colorbox.xml, editbtn.xml

Browse Source 
git-svn-id: trunk@18558 -
This commit is contained in:
kirkpatc 2009-02-04 12:08:02 +00:00
parent 564736fc55
commit fd4205614a
6 changed files with 82 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/xml/lcl/buttons.xml
View File

@ -203,7 +203,7 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TButtonGlyph.Create" link="#rtl.System.TObject.Create">
<element name="TButtonGlyph.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
@ -212,9 +212,11 @@ Constructors allocate memory and system resources needed by the object. They als
</descr>
<errors/>
<seealso/>
<short>
<var>Create</var> - constructor for <var>TButtonGlyph</var>: frees the Images cache then creates a Glyph Bitmap</short>
</element>
<!-- destructor Visibility: public -->
<element name="TButtonGlyph.Destroy" link="#rtl.System.TObject.Destroy">
<element name="TButtonGlyph.Destroy">
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -228,7 +230,12 @@ Take the following precautions when creating your own Destroy method:
* Remember to call Free for all objects created on the constructor.
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
</seealso>
<short>
<var>Destroy</var> - destructor for <var>TButtonGlyph</var>: frees caches and calls inherited <var>Destroy</var>
</short>
</element>
<!-- function Visibility: public -->
<element name="TButtonGlyph.Draw">
@ -571,7 +578,7 @@ bkYesToAll
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomBitBtn.Create" link="#rtl.Classes.TComponent.Create">
<element name="TCustomBitBtn.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
@ -579,14 +586,19 @@ However, if you create the component by code don´t forget to free it when it is
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.StdCtrls.TCustomButton.Create">TCustomButton.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomBitBtn</var>: calls inherited <var>Create</var> then initialises layout, style and spacing, creates the Button Glyph</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBitBtn.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomBitBtn.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TCustomBitBtn.Destroy">
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -600,7 +612,13 @@ Take the following precautions when creating your own Destroy method:
* Remember to call Free for all objects created on the constructor.
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
<link id="#LCL.StdCtrls.TCustomButton.Destroy">TCustomButton.Destroy</link>
</seealso>
<short>
<var>Destroy</var> - destructor for <var>TCustomBitBtn</var>: frees Button Glyph then calls inherited <var>Destroy</var>
</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomBitBtn.Glyph">
@ -1404,9 +1422,6 @@ is done automatically by the streaming system.
<p>
<var>Create</var> - constructor for <var>TCustomSpeedButton</var>: calls inherited <var>Create</var> and initialises many defaults and properties</p>
<p>Among the properties set are Glyph, initial bounds, control style, layout, colour, caption and mouse responses</p>
<p>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.</p>
<p>However, if you create the component by code don´t forget to free it when it is no longer needed.</p>
<p>Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</p>
</descr>
<errors/>
<seealso>
@ -1420,11 +1435,15 @@ is done automatically by the streaming system.
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomSpeedButton.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short>Destroy this instance of a graphic control and return its resources</short>
<element name="TCustomSpeedButton.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomSpeedButton</var>: frees Glyph then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Destroy">TGraphicControl.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomSpeedButton.Click" link="#LCL.Controls.TControl.Click">

4
docs/xml/lcl/calendar.xml
View File

@ -290,7 +290,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomCalendar</var>: calls inherited <var>Create</var> and sets style, initial bounds, display settings; sets date and time to Now</short>
@ -300,7 +300,7 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomCalendar.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TCustomCalendar.Destroy" link="#LCL.Controls.TWinControl.Destroy">
<short/>
<descr/>
<errors/>

30
docs/xml/lcl/chart.xml
View File

@ -129,22 +129,31 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomBarChart.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TCustomBarChart.Create">
<short>
<var>Create</var> - constructor for <var>TCustomBarChart</var>: calls inherited <var>Create</var> and creates the bars, sets initial bounds and label position</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.ExtCtrls.TCustomPanel.Create">TCustomPanel.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBarChart.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomBarChart.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<element name="TCustomBarChart.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomBarChart</var>: frees the bars and calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
<link id="#LCL.ExtCtrls.TCustomPanel.Destroy">TCustomPanel.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomBarChart.Clear">
@ -502,7 +511,14 @@
<short>
<var>TBarChartItems</var> - the collection of items defining the bars in this barchart</short>
</element>
<element name="TBarChartItems.Create" link="#rtl.Classes.TCollection.Create"/>
<element name="TBarChartItems.Create">
<short>
<var>Create</var> - constructor for <var>TBarChartItems</var>: calls inherited <var>Create</var> and attaches itself to the nominated <var>BarChart</var>
</short>
<seealso>
<link id="#rtl.Classes.TCollection.Create">TCollection.Create</link>
</seealso>
</element>
<element name="TCustomBarChart.Bars">
<short>
<var>Bars</var> - the collection of bars that comprise the BarChart</short>

8
docs/xml/lcl/checklst.xml
View File

@ -158,10 +158,14 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomCheckListBox.Create" link="#rtl.Classes.TComponent.Create">
<element name="TCustomCheckListBox.Create">
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.StdCtrls.TCustomListBox.Create">TCustomListBox.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomCheckListBox</var>: calls inherited <var>Create</var>, finds the data size</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomCheckListBox.Create.AOwner">

16
docs/xml/lcl/colorbox.xml
View File

@ -991,7 +991,13 @@
</element>
<element name="TCustomColorBox.SetStyle" link="#LCL.StdCtrls.TCustomComboBox.SetStyle"/>
<element name="TCustomColorBox.DrawItem" link="#LCL.StdCtrls.TCustomComboBox.DrawItem"/>
<element name="TCustomColorBox.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TCustomColorBox.Create">
<short>
<var>Create</var> - constructor for TCustomColorBox: calls inherited <var>Create</var>, sets style, default colours and colour list, ReadOnly and Selected properties</short>
<seealso>
<link id="#LCL.StdCtrls.TCustomCombobox.Create">TCustomCombobox.Create</link>
</seealso>
</element>
<element name="TCustomColorBox.SetColorList">
<short>
<var>SetColorList</var> - specifies the list of colours to be presented in the drop-down</short>
@ -1016,7 +1022,13 @@
<var>SetStyle</var> - specify the Style</short>
</element>
<element name="TCustomColorListBox.DrawItem" link="#LCL.StdCtrls.TCustomListBox.DrawItem"/>
<element name="TCustomColorListBox.Create" link="#rtl.Classes.TComponent.Create"/>
<element name="TCustomColorListBox.Create">
<short>
<var>Create</var> - constructor for <var>TCustomColorListBox</var>: calls inherited <var>Create</var>, initialises style, default colours and sets colour list</short>
<seealso>
<link id="#LCL.StdCtrls.TCustomListBox.Create">TCustomListBox.Create</link>
</seealso>
</element>
<element name="TCustomColorListBox.SetColorList">
<short>
<var>SetColorList</var> - specifies the list of colours</short>

8
docs/xml/lcl/editbtn.xml
View File

@ -413,7 +413,7 @@
<!-- constructor Visibility: public -->
<element name="TCustomEditButton.Create">
<short>
<var>Create</var> - constructor for <var>TCustomEditutton</var>: calls inherited <var>Create</var> then sets some defaults and initialises some variables</short>
<var>Create</var> - constructor for <var>TCustomEditButton</var>: calls inherited <var>Create</var> then sets some defaults and initialises some variables</short>
<descr>
<p>
<var>Create</var> - constructor for <var>TCustomEditutton</var>: calls inherited <var>Create</var> then sets some defaults and initialises some variables</p>
@ -1760,7 +1760,7 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TDateEdit.Create" link="#LCL.EditBtn.TCustomEditButton.Create">
<element name="TDateEdit.Create">
<short>
<var>Create</var> - constructor for <var>TDateEdit</var>: calls inherited <var>Create</var> and sets defaults</short>
<descr>
@ -1769,7 +1769,9 @@
<p>Initialises dialog title, captions, display settings and default date</p>
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.EditBtn.TCustomEditButton.Create">TCustomEditButton.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TDateEdit.Create.AOwner">