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

FPDoc - fixed constructors and destructors in actnlist.xml and stdctrls.xml

Browse Source 
git-svn-id: trunk@18344 -
This commit is contained in:
kirkpatc 2009-01-19 16:58:08 +00:00
parent e40a89eb2c
commit 1789510f17
2 changed files with 159 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/xml/lcl/actnlist.xml
View File

@ -499,13 +499,19 @@ Take the following precautions when creating your own Destroy method:
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomActionList.Create" link="#rtl.Classes.TComponent.Create"/> <element name="TCustomActionList.Create">
<short>
<var>Create</var> - constructor for <var>TCustomActionList</var>: calls inherited <var>Create</var> then initialises some local variables</short>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
</seealso>
</element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomActionList.Create.AOwner"> <element name="TCustomActionList.Create.AOwner">
<short/> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TCustomActionList.Destroy" link="#rtl.Classes.TComponent.Destroy"> <element name="TCustomActionList.Destroy">
<descr> <descr>
<var>Destroy</var> sends a <var>opRemove</var> notification to all components <var>Destroy</var> sends a <var>opRemove</var> notification to all components
in the free-notification list. After that, all owned components are in the free-notification list. After that, all owned components are
@ -514,6 +520,12 @@ destroyed by calling <link id="TComponent.DestroyComponents">DestroyComponents</
is done, the component removes itself from its owner's child component list. is done, the component removes itself from its owner's child component list.
After that, the parent's destroy method is called. After that, the parent's destroy method is called.
</descr> </descr>
<short>
<var>Destroy</var> - destructor for <var>TCustomActionList</var>: frees various links then calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
</seealso>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomActionList.ExecuteAction" link="#rtl.Classes.TComponent.ExecuteAction"> <element name="TCustomActionList.ExecuteAction" link="#rtl.Classes.TComponent.ExecuteAction">
@ -1083,13 +1095,26 @@ execution will end up at the <var>TPersistent</var> implementation of
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomAction.Create" link="#rtl.Classes.TBasicAction.Create"/> <element name="TCustomAction.Create">
<short>
<var>Create</var> - constructor for <var>TCustomAction</var>: calls inherited <var>Create</var> then initialises some local variables</short>
<seealso>
<link id="#rtl.Classes.TBasicAction.Create"/>
</seealso>
</element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomAction.Create.AOwner"> <element name="TCustomAction.Create.AOwner">
<short/> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TCustomAction.Destroy" link="#rtl.Classes.TBasicAction.Destroy"/> <element name="TCustomAction.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomAction</var>: frees various lists and images, then calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#rtl.Classes.TBasicAction.Destroy"/>
</seealso>
</element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomAction.DoHint"> <element name="TCustomAction.DoHint">
<short> <short>
@ -1198,7 +1223,7 @@ execution will end up at the <var>TPersistent</var> implementation of
</seealso> </seealso>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TAction.Create" link="#rtl.Classes.TBasicAction.Create"/> <element name="TAction.Create" link="#LCL.ActnList.TCustomAction.Create"/>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TAction.Create.AOwner"> <element name="TAction.Create.AOwner">
<short/> <short/>

175
docs/xml/lcl/stdctrls.xml
View File

@ -421,20 +421,28 @@
<short/> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomScrollBar.CreateParams" link="#LCL.Controls.TWinControl.CreateParams"> <element name="TCustomScrollBar.CreateParams">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.CreateParams"/>
</seealso>
<short>
<var>CreateParams</var> - calls inherited <var>CreateParams</var> then sets up style and alignment depending on whether horizontal or vertical</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomScrollBar.CreateParams.Params"> <element name="TCustomScrollBar.CreateParams.Params">
<short>The paramaeter list</short> <short>The paramaeter list</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomScrollBar.CreateWnd" link="#LCL.Controls.TWinControl.CreateWnd"> <element name="TCustomScrollBar.CreateWnd">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.CreateWnd"/>
</seealso>
<short>
<var>CreateWnd</var> - calls inherited <var>CreateWnd</var> then initialises various Scroll Info properties</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomScrollBar.Change"> <element name="TCustomScrollBar.Change">
@ -459,10 +467,14 @@
<short>The position of the scrolling device</short> <short>The position of the scrolling device</short>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomScrollBar.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomScrollBar.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomScrollBar</var>: calls inherited <var>Create</var> then initialises size, style and various local variables</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomScrollBar.Create.AOwner"> <element name="TCustomScrollBar.Create.AOwner">
@ -863,11 +875,14 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<short/> <short/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomGroupBox.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomGroupBox.Create">
<short/> <short>
<var>Create</var> - constructor for <var>TCustomGroupBox</var>: calls inherited <var>Create</var> then initialises style and bounds</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomGroupBox.Create.AOwner"> <element name="TCustomGroupBox.Create.AOwner">
@ -1728,16 +1743,25 @@ False is set when the edit or combobox control loses focus.
<short/> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomComboBox.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd"> <element name="TCustomComboBox.InitializeWnd">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.InitializeWnd"/>
</seealso>
<short>
<var>InitializeWnd</var> - creates the underlying interface-object: calls inherited <var>InitializeWnd</var> then sets up several local lists and variables notably for style and size</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomComboBox.DestroyWnd" link="#LCL.Controls.TWinControl.DestroyWnd"> <element name="TCustomComboBox.DestroyWnd">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.DestroyWnd"/>
</seealso>
<short>
<var>DestroyWnd</var> - finds somewhere to store locally held variables then frees lists, cals inherited <var>DestroyWnd</var>
</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomComboBox.DoEnter" link="#LCL.Controls.TWinControl.DoEnter"> <element name="TCustomComboBox.DoEnter" link="#LCL.Controls.TWinControl.DoEnter">
@ -2251,20 +2275,29 @@ False is set when the edit or combobox control loses focus.
- whether the entries in the drop-down list have been sorted</short> - whether the entries in the drop-down list have been sorted</short>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomComboBox.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomComboBox.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for TCustomComboBox: calls inherited <var>Create</var> then initialises styles, item lists, bounds and various other local variables</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomComboBox.Create.TheOwner"> <element name="TCustomComboBox.Create.TheOwner">
<short/> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TCustomComboBox.Destroy" link="#LCL.Controls.TWinControl.Destroy"> <element name="TCustomComboBox.Destroy">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
</seealso>
<short>
<var>Destroy</var> - destructor for <var>TCustomComboBox</var>: frees handles, itemlists, canvas and items then calls inherited <var>Destroy</var>
</short>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomComboBox.IntfGetItems"> <element name="TCustomComboBox.IntfGetItems">
@ -3607,20 +3640,29 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomListBox.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomListBox.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomListBox</var>: calls inherited <var>Create</var> then initialises style, canvas, item list and various other local variables</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomListBox.Create.TheOwner"> <element name="TCustomListBox.Create.TheOwner">
<short/> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TCustomListBox.Destroy" link="#LCL.Controls.TWinControl.Destroy"> <element name="TCustomListBox.Destroy">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
</seealso>
<short>
<var>Destroy</var>: destructor for <var>TCustomListBox</var>: frees canvas and item list, then calls inherited <var>Destroy</var>
</short>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TCustomListBox.GetIndexAtY"> <element name="TCustomListBox.GetIndexAtY">
@ -4719,11 +4761,13 @@ Indicates how text is displayed in a text editing control.</p>
<short/> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomEdit.CreateWnd" link="#LCL.Controls.TWinControl.CreateWnd"> <element name="TCustomEdit.CreateWnd">
<short/> <short>CreateWnd - calls inherited <var>CreateWnd</var>, then initialises various properties relevant to the Widget Set in use</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.CreateWnd"/>
</seealso>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomEdit.TextChanged" link="#LCL.Controls.TControl.TextChanged"> <element name="TCustomEdit.TextChanged" link="#LCL.Controls.TControl.TextChanged">
@ -4947,10 +4991,14 @@ Indicates how text is displayed in a text editing control.</p>
</descr> </descr>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomEdit.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomEdit.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomEdit</var>: calls inherite <var>Create</var> then initialises style, colour, size and various other local variables</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomEdit.Create.AOwner"> <element name="TCustomEdit.Create.AOwner">
@ -5510,22 +5558,31 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
<short/> <short/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomMemo.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomMemo.Create">
<descr>Create the Custom memo widget <descr>Create the Custom memo widget
</descr> </descr>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomMemo</var>: calls inherited <var>Create</var> then initialises some variables, creates the stringlist and creates scrollbars</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomMemo.Create.AOwner"> <element name="TCustomMemo.Create.AOwner">
<short/> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TCustomMemo.Destroy" link="#LCL.Controls.TWinControl.Destroy"> <element name="TCustomMemo.Destroy">
<descr>Destroy the CustomMemo widget when you have finished with it <descr>Destroy the CustomMemo widget when you have finished with it
</descr> </descr>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
</seealso>
<short>
<var>Destroy</var> - destructor for <var>TCustomMemo</var>: frees stringlist and scrollbars then calls inherited <var>Destroy</var>
</short>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TCustomMemo.Append"> <element name="TCustomMemo.Append">
@ -6383,10 +6440,14 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<short/> <short/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomStaticText.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomStaticText.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomStaticText</var>: calls inherited <var>Create</var> the initialises style, alignment and bounds</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomStaticText.Create.AOwner"> <element name="TCustomStaticText.Create.AOwner">
@ -6842,10 +6903,14 @@ is done automatically by the streaming system.
- event handler for any change in properties of the control</short> - event handler for any change in properties of the control</short>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TButtonControl.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TButtonControl.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TButtonControl</var>: calls inherited <var>Create</var> then initialises style</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TButtonControl.Create.TheOwner"> <element name="TButtonControl.Create.TheOwner">
@ -7169,11 +7234,15 @@ is done automatically by the streaming system.
<short/> <short/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomButton.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomButton.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. <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.
</descr> </descr>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomButton</var>: calls inherited <var>Create</var> then initialises style, colour, bounds, alignment and various other properties</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomButton.Create.TheOwner"> <element name="TCustomButton.Create.TheOwner">
@ -7770,11 +7839,14 @@ is the ancestor of all check-box components.</short>
<short/> <short/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomCheckBox.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TCustomCheckBox.Create">
<short/> <short>
<var>Create</var> - constructor for TCustomCheckBox: calls inherited <var>Create</var> then initialises style, and state, bounds, tabstop and autosize</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomCheckBox.Create.TheOwner"> <element name="TCustomCheckBox.Create.TheOwner">
@ -8043,10 +8115,14 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
</seealso> </seealso>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TToggleBox.Create" link="#rtl.Classes.TComponent.Create"> <element name="TToggleBox.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.StdCtrls.TCustomCheckBox.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TToggleBox</var>: calls inherited <var>Create</var> then initialises style and makes autosize False</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TToggleBox.Create.TheOwner"> <element name="TToggleBox.Create.TheOwner">
@ -8312,11 +8388,14 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th
<seealso/> <seealso/>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TRadioButton.Create" link="#LCL.Controls.TWinControl.Create"> <element name="TRadioButton.Create">
<short/> <short>
<var>Create</var> - constructor for <var>TRadioButton</var>: calls inherited <var>Create</var> then initialises style</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.StdCtrls.TCustomCheckBox.Create"/>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TRadioButton.Create.TheOwner"> <element name="TRadioButton.Create.TheOwner">
@ -8990,10 +9069,14 @@ is done automatically by the streaming system.
- boolean. If True, font size is adjusted for optimal fill of available space</short> - boolean. If True, font size is adjusted for optimal fill of available space</short>
</element> </element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomLabel.Create" link="#LCL.Controls.TGraphicControl.Create"> <element name="TCustomLabel.Create">
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomLabel</var>: calls inherited <var>Create</var> then initialises style, bounds, colour and some other properties</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomLabel.Create.TheOwner"> <element name="TCustomLabel.Create.TheOwner">