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

FPDoc - added short descriptions for Unit headers; some updates to TCustomScrollBar and TCustomMemo in stdctrls

Browse Source 
git-svn-id: trunk@21439 -
This commit is contained in:
kirkpatc 2009-08-25 07:06:38 +00:00
parent 1f7b31fa7f
commit 141dffc70a
4 changed files with 2031 additions and 2803 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

695
docs/xml/lcl/extendedstrings.xml
View File

@ -1,415 +1,292 @@
<?xml version="1.0" encoding="ISO8859-1"?>
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
<package name="lcl">
<!--
====================================================================
ExtendedStrings
====================================================================
-->
<module name="ExtendedStrings">
<short></short>
<descr>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration type Visibility: default -->
<element name="TExtStringsOption">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoClearRecordsOnCreate">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoFreeObjectsOnDelete">
<short></short>
</element>
<!-- set type Visibility: default -->
<element name="TExtStringsOptions">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TExtendedStringList">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FOptions">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FRecordSize">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- function Visibility: private -->
<element name="TExtendedStringList.GetRecords">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetRecords.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetRecords.Index">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetOptions">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetOptions.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetRecords">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.Index">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetRecordSize">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecordSize.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.DoResizeRecord">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.Index">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.OldSize">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.NewSize">
<short></short>
</element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.ResizeRecord">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.ARecord">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.Index">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.OldSize">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.NewSize">
<short></short>
</element>
<!-- function Visibility: protected -->
<element name="TExtendedStringList.GetObject">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetObject.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetObject.Index">
<short></short>
</element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.PutObject">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.Index">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.AnObject">
<short></short>
</element>
<!-- constructor Visibility: public -->
<element name="TExtendedStringList.Create">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Create.InitialRecordSize">
<short></short>
</element>
<!-- destructor Visibility: public -->
<element name="TExtendedStringList.Destroy">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Clear">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Delete">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Delete.Index">
<short></short>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.CreateRecord">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.CreateRecord.Index">
<short></short>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeRecord">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.FreeRecord.Index">
<short></short>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeAllRecords">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TExtendedStringList.RecordAllocated">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Index">
<short></short>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Records">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Records.Index">
<short></short>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.RecordSize">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Options">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- ExtendedStrings -->
</package>
<module name="ExtendedStrings">
<short>Defines <var>TExtendedStrings</var> which is a normal <var>TStringList</var>, except that the Objects can hold any type of records</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TExtStringsOption">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoClearRecordsOnCreate">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoFreeObjectsOnDelete">
<short/>
</element>
<!-- set type Visibility: default -->
<element name="TExtStringsOptions">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TExtendedStringList">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FOptions">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FRecordSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TExtendedStringList.GetRecords">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetRecords.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetRecords.Index">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetOptions">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetOptions.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetRecords">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.Index">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.SetRecordSize">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecordSize.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TExtendedStringList.DoResizeRecord">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.Index">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.OldSize">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.NewSize">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.ResizeRecord">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.ARecord">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.Index">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.OldSize">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.NewSize">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TExtendedStringList.GetObject">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetObject.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetObject.Index">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.PutObject">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.Index">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.AnObject">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TExtendedStringList.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Create.InitialRecordSize">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TExtendedStringList.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Clear">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Delete">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Delete.Index">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.CreateRecord">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.CreateRecord.Index">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeRecord">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.FreeRecord.Index">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeAllRecords">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: public -->
<element name="TExtendedStringList.RecordAllocated">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Index">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Records">
<short/>
<descr/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Records.Index">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.RecordSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Options">
<short/>
<descr/>
<seealso/>
</element>
</module>
<!-- ExtendedStrings -->
</package>
</fpdoc-descriptions>

6
docs/xml/lcl/lclintf.xml
View File

@ -7,8 +7,10 @@
====================================================================
-->
<module name="LCLIntf">
<short/>
<descr/>
<short>Contains constanta and type definitions for Delphi compatibility</short>
<descr>
<p>This unit is being created specifically for compatibility with Delphi. It should only be used for constants and type definitions that are included in the Delphi Windows unit. This is only done for compatibility</p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Math">
<short/>

4053
docs/xml/lcl/lresources.xml
View File

File diff suppressed because it is too large Load Diff

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

@ -474,10 +474,13 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomScrollBar.Change">
<short>Change the scroll Bar</short>
<short>
<var>Change</var> - method to signal that a change has occured</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TControl.Changed">TControl.Changed</link>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomScrollBar.Scroll">
@ -1806,7 +1809,7 @@ False is set when the edit or combobox control loses focus.
<link id="#LCL.Controls.TWinControl.DestroyWnd">TWinControl.DestroyWnd</link>
</seealso>
<short>
<var>DestroyWnd</var> - finds somewhere to store locally held variables then frees lists, cals inherited <var>DestroyWnd</var>
<var>DestroyWnd</var> - finds somewhere to store locally held variables then frees lists, calls inherited <var>DestroyWnd</var>
</short>
</element>
<!-- procedure Visibility: protected -->
@ -5497,7 +5500,13 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
</element>
<!-- function result Visibility: default -->
<element name="TCustomMemo.RealGetText.Result">
<short/>
<short>Returns the value found in <var>Lines.Text</var>, the area allocated for storage of the textual data of the Memo.</short>
<descr>
<p>
<printshort id="TCustomMemo.RealGetText.Result"/>
</p>
<p>The result is of type <var>TCaption</var>, a string type for the caption of a control: may be translated</p>
</descr>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomMemo.RealSetText">
@ -5522,11 +5531,11 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
</element>
<!-- function result Visibility: default -->
<element name="TCustomMemo.GetCachedText.Result">
<short/>
<short>Returns a False result</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomMemo.GetCachedText.CachedText">
<short/>
<short>The <var>CachedText</var> of type TCaption that is being fetched</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomMemo.SetAlignment">
@ -5616,7 +5625,12 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
<element name="TCustomMemo.Loaded">
<short>
<var>Loaded</var> calls inherited method then sets the ScrollBar and WordWrap properties</short>
<descr/>
<descr>
<p>
<printshort id="TCustomMemo.Loaded"/>
</p>
<p>The <var>Loaded</var> method is called when a component has finished loading; the various ancestor classes copy properties from client and parent classes into the newly loaded component, and notify any child components of changes that have been made</p>
</descr>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Loaded">TComponent.Loaded</link>
@ -5633,7 +5647,7 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
</element>
<!-- function result Visibility: default -->
<element name="TCustomMemo.WordWrapIsStored.Result">
<short/>
<short>The result of a test to see whether the property <var>WordWrap</var> has been stored</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomMemo.ControlKeyDown" link="#LCL.Controls.TWinControl.ControlKeyDown">
@ -5664,7 +5678,7 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
<!-- function Visibility: protected -->
<element name="TCustomMemo.GetControlClassDefaultSize">
<short>
<var>GetControlClassDefaultSize</var> - sets its own defaults, overriding inherited method</short>
<var>GetControlClassDefaultSize</var> - makes its own defaults, overriding inherited method</short>
<descr/>
<errors/>
<seealso>
@ -5673,15 +5687,20 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
</element>
<!-- function result Visibility: default -->
<element name="TCustomMemo.GetControlClassDefaultSize.Result">
<short/>
<short>Returns the default size, stored as a TPoint</short>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomMemo.Create">
<descr>Create the Custom memo widget
</descr>
<descr>
<p>
<printshort id="TCustomMemo.Create"/>
</p>
<p>The various ancestor methods first create the object, then initialise sizes, styles, fonts and positions of subsidiary objects</p>
</descr>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Create">TWinControl.Create</link>
<link id="#LCL.StdCtrls.TCustomEdit.Create">TCustomEdit.Create</link>
</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>
@ -5692,8 +5711,12 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels
</element>
<!-- destructor Visibility: public -->
<element name="TCustomMemo.Destroy">
<descr>Destroy the CustomMemo widget when you have finished with it
</descr>
<descr>
<p>
<printshort id="TCustomMemo.Destroy"/>
</p>
<p>The ancestor destructor removes the resources that have been used, in a systematic and orderly way</p>
</descr>
<errors/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy">TWinControl.Destroy</link>
@ -10015,6 +10038,35 @@ Reads or Writes flag if control is re-sized.
<element name="TToggleBox.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomLabel.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<element name="TStaticText.DragKind" link="#LCL.Controls.TControl.DragKind"/>
<element name="TCustomMemo.InitializeWnd">
<short>
<var>InitializeWnd</var> - initialises the window by creating the borders and outline, then loading up any strings that have already been specified for display</short>
<descr>
<p>
<printshort id="TCustomMemo.InitializeWnd"/>
</p>
<p>Calls the inherited method which works out the correct bounds, sets style, fonts and colours, performs any pending resize operations</p>
</descr>
<seealso>
<link id="#LCL.Controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
</seealso>
</element>
<element name="TCustomMemo.FinalizeWnd">
<short>
<var>FinalizeWnd</var> - getting ready to close down the window: first stores the text strings in a safe place, then frees the storage occupied by them</short>
<descr>
<p>
<printshort id="TCustomMemo.FinalizeWnd"/>
</p>
<p>Calls the inherited method, which prepares to free the handle for this window</p>
</descr>
<seealso>
<link id="#LCL.Controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
</seealso>
</element>
<element name="TCustomMemo.GetCaretPos.Result">
<short>Returns the position of the cursor marker or caret</short>
</element>
</module>
<!-- StdCtrls -->
</package>