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 - small changes to menus.xml and extctrls.xml; descriptions for TFieldDataLink and others added to DBCtrls.xml

Browse Source 
git-svn-id: trunk@18590 -
This commit is contained in:
kirkpatc 2009-02-05 21:09:02 +00:00
parent 321c976935
commit 708915f844
3 changed files with 66 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/xml/lcl/dbctrls.xml
View File

@ -301,11 +301,12 @@
<descr/>
<errors/>
<seealso>
<link id="#rtl.System.TObject.Create"/>
<link id="#rtl.System.TObject.Create">TObject.Create</link>
<link id="#fcl.db.TDataLink.Create">TDataLink.Create</link>
</seealso>
</element>
<!-- destructor Visibility: public -->
<element name="TFieldDataLink.Destroy" link="#rtl.Classes.TPersistent.Destroy">
<element name="TFieldDataLink.Destroy" link="#lcl.db.TDataLink.Destroy">
<short/>
<descr/>
<errors/>
@ -632,11 +633,11 @@
<!-- constructor Visibility: public -->
<element name="TDBEdit.Create">
<short>
<var>Create</var> - Constructor for <var>TDBEdit</var>: cals inherited <var>Create</var> then sets up data links and actions</short>
<var>Create</var> - Constructor for <var>TDBEdit</var>: calls inherited <var>Create</var> then sets up data links and actions</short>
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomEdit.Create"/>
<link id="#LCL.StdCtrls.TCustomEdit.Create">TCustomEdit.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -651,7 +652,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -1157,7 +1158,7 @@ consideration when overriding this method.
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomLabel.Create"/>
<link id="#LCL.StdCtrls.TCustomLabel.Create">TCustomLabel.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -1172,7 +1173,7 @@ consideration when overriding this method.
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Destroy"/>
<link id="#LCL.Controls.TGraphicControl.Destroy">TGraphicControl.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -2094,7 +2095,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomRadioGroup.Create"/>
<link id="#LCL.ExtCtrls.TCustomRadioGroup.Create">TCustomRadioGroup.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2109,7 +2110,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomRadioGroup.Destroy"/>
<link id="#LCL.ExtCtrls.TCustomRadioGroup.Destroy">TCustomRadioGroup.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -2512,7 +2513,7 @@ Reads or Writes flag if control is re-sized.
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomCheckBox.Create"/>
<link id="#LCL.StdCtrls.TCustomCheckBox.Create">TCustomCheckBox.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2527,7 +2528,7 @@ Reads or Writes flag if control is re-sized.
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -3539,11 +3540,11 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<!-- constructor Visibility: public -->
<element name="TDBMemo.Create">
<short>
<var>Create</var> - constructor fro <var>TDBMemo</var>: calls inherited <var>Create</var>, then sets style and forms datalinks and actions</short>
<var>Create</var> - constructor for <var>TDBMemo</var>: calls inherited <var>Create</var>, then sets style and forms datalinks and actions</short>
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomMemo.Create"/>
<link id="#LCL.StdCtrls.TCustomMemo.Create">TCustomMemo.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -3553,12 +3554,12 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<!-- destructor Visibility: public -->
<element name="TDBMemo.Destroy">
<short>
<var>Destroy</var> - destructor fro <var>TDBMemo</var>: frees datalinks then calls inherited <var>Destroy</var>
<var>Destroy</var> - destructor for <var>TDBMemo</var>: frees datalinks then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomMemo.Destroy"/>
<link id="#LCL.StdCtrls.TCustomMemo.Destroy">TCustomMemo.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -3841,7 +3842,7 @@ consideration when overriding this method.
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomGroupBox.Create"/>
<link id="#LCL.StdCtrls.TCustomGroupBox.Create">TCustomGroupBox.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -3850,12 +3851,13 @@ consideration when overriding this method.
</element>
<!-- destructor Visibility: public -->
<element name="TDBGroupBox.Destroy">
<short>Destroy - destructor for <var>TDBGroupBox</var>: frees datalinks then calls inherited <var>Destroy</var>
<short>
<var>Destroy</var> - destructor for <var>TDBGroupBox</var>: frees datalinks then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -4332,7 +4334,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomImage.Create"/>
<link id="#LCL.ExtCtrls.TCustomImage.Create">TCustomImage.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -4347,7 +4349,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomImage.Destroy"/>
<link id="#LCL.ExtCtrls.TCustomImage.Destroy">TCustomImage.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -4647,7 +4649,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.Calendar.TCustomCalendar.Create"/>
<link id="#LCL.Calendar.TCustomCalendar.Create">TCustomCalendar.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -4662,7 +4664,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -5183,7 +5185,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomPanel.Create"/>
<link id="#LCL.ExtCtrls.TCustomPanel.Create">TCustomPanel.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -5198,7 +5200,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TCustomControl.Destroy"/>
<link id="#LCL.Controls.TCustomControl.Destroy">TCustomControl.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -5369,11 +5371,11 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<!-- constructor Visibility: public -->
<element name="TDBNavDataLink.Create">
<short>
<var>Create</var> - constructor for TDBNavDataLink: calls inherited <var>Create</var>, attaches <var>Navigator</var> and sets <var>VisualControl</var> to True</short>
<var>Create</var> - constructor for <var>TDBNavDataLink</var>: calls inherited <var>Create</var>, attaches <var>Navigator</var> and sets <var>VisualControl</var> to True</short>
<descr/>
<errors/>
<seealso>
<link id="#rtl.System.TObject.Create"/>
<link id="#rtl.System.TObject.Create">TObject.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -5388,7 +5390,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TPersistent.Destroy"/>
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
</seealso>
</element>
<!-- object Visibility: default -->

52
docs/xml/lcl/extctrls.xml
View File

@ -321,7 +321,7 @@
<descr/>
<errors/>
<seealso>
<link id="#lcl.Controls.TControl.Create"/>
<link id="#lcl.Controls.TControl.Create">TControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -511,7 +511,7 @@
<descr/>
<errors/>
<seealso>
<link id="#rtl.System.TObject.Create"/>
<link id="#rtl.System.TObject.Create">TObject.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TNBPages</var>: calls inherited <var>Create</var> then sets up the list of pages on the notebook</short>
@ -1144,7 +1144,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -1159,7 +1159,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- function Visibility: public -->
@ -1927,7 +1927,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.CustomTimer.TCustomTimer.Create"/>
<link id="#LCL.CustomTimer.TCustomTimer.Create">TCustomTimer.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -1942,7 +1942,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.CustomTimer.TCustomTimer.Destroy"/>
<link id="#LCL.CustomTimer.TCustomTimer.Destroy">TCustomTimer.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -2088,7 +2088,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
<link id="#LCL.Controls.TGraphicControl.Create">TGraphicControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2103,7 +2103,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Destroy"/>
<link id="#LCL.Controls.TGraphicControl.Destroy">TGraphicControl.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -2659,7 +2659,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TCustomControl.Create"/>
<link id="#LCL.Controls.TCustomControl.Create">TCustomControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2904,7 +2904,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
<link id="#LCL.Controls.TGraphicControl.Create">TGraphicControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -3218,7 +3218,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
<link id="#LCL.Controls.TGraphicControl.Create">TGraphicControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -3233,7 +3233,7 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Destroy"/>
<link id="#LCL.Controls.TGraphicControl.Destroy">TGraphicControl.Destroy</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -3598,10 +3598,10 @@
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
<link id="#LCL.Controls.TGraphicControl.Create">TGraphicControl.Create</link>
</seealso>
<short>
<var>Create</var> - cunstructor for <var>TBevel</var>: calls inherited <var>Create</var> then sets initial style, shape and bounds</short>
<var>Create</var> - constructor for <var>TBevel</var>: calls inherited <var>Create</var> then sets initial style, shape and bounds</short>
</element>
<!-- argument Visibility: default -->
<element name="TBevel.Create.AOwner">
@ -3992,7 +3992,7 @@ requiring the user to select one af a set of alternatives</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.StdCtrls.TCustomGroupBox.Create"/>
<link id="#LCL.StdCtrls.TCustomGroupBox.Create">TCustomGroupBox.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -4007,7 +4007,7 @@ requiring the user to select one af a set of alternatives</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- function Visibility: public -->
@ -4527,7 +4527,7 @@ requiring the user to select one af a set of alternatives</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomGroupBox.Create"/>
<link id="#LCL.ExtCtrls.TCustomGroupBox.Create">TCustomGroupBox.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -4542,7 +4542,7 @@ requiring the user to select one af a set of alternatives</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<!-- function Visibility: public -->
@ -4906,10 +4906,13 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
</element>
<!-- constructor Visibility: public -->
<element name="TBoundLabel.Create">
<short>Create a new instance of a Graphic Control</short>
<short>
<var>Create</var> - constructor for <var>TBoundLabel</var>: calls inherited <var>Create</var>, makes itself a SubComponent to the Owner, and sets its caption to the owner name</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.StdCtrls.TCustomLabel.Create">TCustomLabel.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TBoundLabel.Create.TheOwner">
@ -5220,7 +5223,8 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
<descr/>
<errors/>
<seealso>
<link id="#lcl.StdCtrls.TCustomEdit.Create"/>
<link id="#lcl.StdCtrls.TCustomEdit.Create">TCustomEdit.Create</link>
<link id="#lcl.ExtCtrls.TBoundLabel.Create">TBoundLabel.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -5763,7 +5767,7 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
<descr/>
<errors/>
<seealso>
<link id="#lcl.Controls.TCustomControl.Create"/>
<link id="#lcl.Controls.TCustomControl.Create">TCustomControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -6183,7 +6187,7 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
<short>
<var>Create</var> - constructor for <var>TCustomTrayIcon</var>: performs inherited <var>Create</var> then creates icon, timer and initialises balloon timeout</short>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<element name="TCustomTrayIcon.Destroy">
@ -6195,7 +6199,7 @@ After that, the parent's destroy method is called.
<var>Destroy</var> - destructor for <var>TCustomTrayIcon</var>: frees icon and timer then calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
</seealso>
</element>
<element name="TCustomTrayIcon.Hide">

17
docs/xml/lcl/menus.xml
View File

@ -84,7 +84,8 @@
<!-- object Visibility: default -->
<element name="TMenu">
<short>
<var>TMenu</var> - a menu appearing in a form. Ancestor class for TMainMenu or TPopupMeny</short>
<var>TMenu</var> - a menu appearing in a form. Base class for <var>TMainMenu</var> or <var>TPopupMenu</var>
</short>
<descr>
<p>
<var>TMenu</var> : The base class for all menus</p>
@ -1202,7 +1203,7 @@ Descendent classes can override this method to provide a different result.
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -1216,7 +1217,7 @@ Descendent classes can override this method to provide a different result.
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
</seealso>
</element>
<!-- function Visibility: public -->
@ -1920,7 +1921,7 @@ Descendent classes can override this method to provide a different result.
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -1935,7 +1936,7 @@ Descendent classes can override this method to provide a different result.
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -2087,7 +2088,7 @@ customise by choosing various menu items.</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.Menus.TMenu.Create"/>
<link id="#LCL.Menus.TMenu.Create">TMenu.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2183,7 +2184,7 @@ customise by choosing various menu items.</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.Menus.TMenu.Create"/>
<link id="#LCL.Menus.TMenu.Create">TMenu.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2198,7 +2199,7 @@ customise by choosing various menu items.</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.Menus.TMenu.Destroy"/>
<link id="#LCL.Menus.TMenu.Destroy">TMenu.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->