FPDoc - definitions added in CustomTimer.xml

git-svn-id: trunk@15182 -
This commit is contained in:
kirkpatc 2008-05-19 13:39:09 +00:00
parent 3d2bb7d1e3
commit 5cfa24eb18

View File

@ -1,302 +1,212 @@
<?xml version="1.0" encoding="ISO8859-1"?>
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
<package name="lcl">
<!--
====================================================================
CustomTimer
====================================================================
-->
<module name="CustomTimer">
<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>
<!-- unresolved type reference Visibility: default -->
<element name="LCLStrConsts">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="InterfaceBase">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TCustomTimer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FInterval">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnStartTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnStopTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FTimerHandle">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FEnabled">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomTimer.Timer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetEnabled">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetEnabled.Value">
<short></short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetInterval">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetInterval.Value">
<short></short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetOnTimer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetOnTimer.Value">
<short></short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.DoOnTimer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.UpdateTimer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.KillTimer">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.Create.AOwner">
<short></short>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Enabled">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Interval">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStartTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStopTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- CustomTimer -->
</package>
<module name="CustomTimer">
<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>
<!-- unresolved type reference Visibility: default -->
<element name="LCLStrConsts">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="InterfaceBase">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomTimer">
<short>
<var>TCustomTimer</var> - base class for <var>TTimer</var>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FInterval">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnStartTimer">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnStopTimer">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FTimerHandle">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnTimer">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FEnabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomTimer.Timer">
<short>
<var>Timer</var> - procedure that is called when the timer has expired; calls user's <var>OnTimer </var>function.</short>
<descr>Is called when the timer has expired and calls users OnTimer function.</descr>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetEnabled">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetEnabled.Value">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetInterval">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetInterval.Value">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetOnTimer">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetOnTimer.Value">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.DoOnTimer">
<short>
<var>DoOnTimer</var> - calls <var>OnTimer</var> event handler</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.UpdateTimer">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.KillTimer">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Enabled">
<short>
<var>Enabled</var> - if True, timer is ready to start</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Interval">
<short>The <var>Interval</var> for which the timer is to run</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnTimer">
<short>
<var>OnTimer</var> - event handler for timer interval complete (expired)</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStartTimer">
<short>
<var>OnStartTimer</var> - event handler for starting the timer running</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStopTimer">
<short>
<var>OnStopTimer</var> - event handler for stopping the timer</short>
<descr/>
<seealso/>
</element>
</module>
<!-- CustomTimer -->
</package>
</fpdoc-descriptions>