mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-22 09:39:31 +02:00
FPDoc - updates and corrections to class descriptions in FPCanvas.xml and FPImage.xml
git-svn-id: trunk@18765 -
This commit is contained in:
kirkpatc
parent
3120bb14c2
commit
1655c12307
@ -51,7 +51,11 @@
|
||||
<element name="TFPCustomCanvas">
|
||||
<short>
|
||||
<var>TFPCustomCanvas</var> - FreePascal base class for Canvas</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TFPCustomCanvas</var> - FreePascal base class for Canvas</p>
|
||||
<p>Many of the methods are virtual and/or abstract; there is often no supplied code for the method, but the entries act as place-holders for programmers of descendant components to provide overriding methods</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -259,18 +263,25 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TFPCanvasHelper.Create" link="#rtl.System.TObject.Create">
|
||||
<short/>
|
||||
<element name="TFPCanvasHelper.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TFPCanvasHelper</var>: calls inherited <var>Create</var> then sets properties <var>Canvas</var> to nil, <var>FixedCanvas</var> and <var>Allocated</var> to False</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TFPCanvasHelper.Destroy" link="#rtl.Classes.TPersistent.Destroy">
|
||||
<short/>
|
||||
<element name="TFPCanvasHelper.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TFPCanvasHelper</var>: de-allocates resources then calls inherited <var>Destroy</var>
|
||||
</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TFPCanvasHelper.AllocateResources">
|
||||
@ -1130,11 +1141,14 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TMitchelInterpolation.Filter" link="#fcl.FPCanvas.TFPBaseInterpolation.Filter">
|
||||
<short/>
|
||||
<element name="TMitchelInterpolation.Filter">
|
||||
<short>
|
||||
<var>Filter</var> uses specific constants as coefficients in a polynomial interpolation</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#fcl.FPCanvas.TFPBaseInterpolation.Filter">TFPBaseInterpolation.Filter</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TMitchelInterpolation.Filter.Result">
|
||||
@ -1960,7 +1974,7 @@
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create"/>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
@ -1976,7 +1990,7 @@
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TPersistent.Destroy"/>
|
||||
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
|
||||
@ -63,8 +63,21 @@
|
||||
<short>
|
||||
<var>EnlargeData</var> - makes room in the array for more data</short>
|
||||
</element>
|
||||
<element name="TFPPalette.Create" link="#rtl.System.TObject.Create"/>
|
||||
<element name="TFPPalette.Destroy" link="#rtl.System.TObject.Destroy"/>
|
||||
<element name="TFPPalette.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TFPPalette</var>: calls inherited <var>Create</var> then finds how much memory to allocate for the specified number of colours</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPPalette.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TFPPalette</var>: frees memory then calls inherited <var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPPalette.Build">
|
||||
<short>
|
||||
<var>Build</var> an Image</short>
|
||||
@ -98,7 +111,7 @@
|
||||
</element>
|
||||
<element name="TFPCustomImage.SetInternalColor">
|
||||
<short>
|
||||
<var>SetInternalColor</var> - specify the internal colour</short>
|
||||
<var>SetInternalColor</var> - specify the internal colour (using TFPColor format)</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage.GetInternalColor">
|
||||
<short>
|
||||
@ -106,11 +119,11 @@
|
||||
</element>
|
||||
<element name="TFPCustomImage.SetInternalPixel">
|
||||
<short>
|
||||
<var>SetInternalPixel</var> - specifies the integer location of a pixel described by its coordinates</short>
|
||||
<var>SetInternalPixel</var> - specifies the integer Color of a pixel located at the given coordinates</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage.GetInternalPixel">
|
||||
<short>
|
||||
<var>GetInternalPixel</var> - returns the integer location of the specified pixel</short>
|
||||
<var>GetInternalPixel</var> - returns the integer Color of the specified pixel</short>
|
||||
</element>
|
||||
<element name="TFPCustomImage.SetUsePalette">
|
||||
<short>
|
||||
@ -120,7 +133,8 @@
|
||||
<short>
|
||||
<var>Progress</var> - method for displaying the progress of a drawing or painting action</short>
|
||||
<descr>
|
||||
<p><var>Progress</var> - method for displaying the progress of a drawing or painting action</p>
|
||||
<p>
|
||||
<var>Progress</var> - method for displaying the progress of a drawing or painting action</p>
|
||||
<p>Sender: calling routine</p>
|
||||
<p>Stage: Starting, Running or Ending</p>
|
||||
<p>PercentDone: how much has been accomplished</p>
|
||||
@ -130,8 +144,21 @@
|
||||
<p>Continue: whether to keep on drawing</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TFPCustomImage.create" link="#rtl.System.TObject.Create"/>
|
||||
<element name="TFPCustomImage.destroy" link="#rtl.Classes.TPersistent.Destroy"/>
|
||||
<element name="TFPCustomImage.create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TFPCustomImage</var>: calls inherited <var>Create</var> then initialises position and size, makes a stringlist</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPCustomImage.destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TFPCustomImage</var>: frees the Palette then calls inherited <var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TFPCustomImage.Assign" link="#rtl.Classes.TPersistent.Assign"/>
|
||||
<element name="TFPCustomImage.LoadFromStream">
|
||||
<short>
|
||||
@ -211,14 +238,15 @@
|
||||
</element>
|
||||
<element name="TFPMemoryImage.SetInternalPixel" link="#fcl.FPimage.TFPCustomImage.SetInternalPixel"/>
|
||||
<element name="TFPMemoryImage.GetInternalPixel" link="#fcl.FPimage.TFPCustomImage.GetInternalPixel"/>
|
||||
<element name="TFPMemoryImage.create" link="#rtl.System.TObject.Create"/>
|
||||
<element name="TFPMemoryImage.destroy" link="#rtl.Classes.TPersistent.Destroy"/>
|
||||
<element name="TFPMemoryImage.create" link="#fcl.FPimage.TFPCustomImage.create"/>
|
||||
<element name="TFPMemoryImage.destroy" link="#fcl.FPimage.TFPCustomImage.destroy"/>
|
||||
<element name="TFPMemoryImage.SetSize" link="#fcl.FPimage.TFPCustomImage.SetSize"/>
|
||||
<element name="TFPCustomImageHandler.Progress">
|
||||
<short>
|
||||
<var>Progress</var> - method for displaying the progress of a drawing or painting action</short>
|
||||
<descr>
|
||||
<p><var>Progress</var> - method for displaying the progress of a drawing or painting action</p>
|
||||
<p>
|
||||
<var>Progress</var> - method for displaying the progress of a drawing or painting action</p>
|
||||
<p>Sender: calling routine</p>
|
||||
<p>Stage: Starting, Running or Ending</p>
|
||||
<p>PercentDone: how much has been accomplished</p>
|
||||
@ -288,8 +316,21 @@
|
||||
<short>
|
||||
<var>TImageHandlersManager</var> - class for managing image handlers</short>
|
||||
</element>
|
||||
<element name="TImageHandlersManager.Create" link="#rtl.System.TObject.Create"/>
|
||||
<element name="TImageHandlersManager.Destroy" link="#rtl.System.TObject.Destroy"/>
|
||||
<element name="TImageHandlersManager.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor fro <var>TImageHandlersManager</var>: calls inherited <var>Create</var> then constructs list of handlers</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Create">TObject.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TImageHandlersManager.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TImageHandlersManager</var>: frees the list of handlers then calls inherited <var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TImageHandlersManager.RegisterImageHandlers">
|
||||
<short>
|
||||
<var>RegisterImageHandlers</var> - method for registering Image Handlers</short>
|
||||
@ -321,6 +362,15 @@
|
||||
<element name="TImageHandlersManager.TypeNames">
|
||||
<short>A list of <var>TypeNames</var> to be used with the handler files</short>
|
||||
</element>
|
||||
<element name="TFPColor">
|
||||
<short>
|
||||
<var>TFPColor</var> - record type used as an internal representation for a colour: a <var>TColor</var> has been decomposed into its component Red, Green, Blue and Alpha parts, to allow easy manipulation of each</short>
|
||||
</element>
|
||||
<element name="PFPColor">
|
||||
<short>
|
||||
<var>PFPColor</var> - pointer to a <var>TFPColor</var>
|
||||
</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user