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

FPDoc - updates to StdActns.xml (corrections) and DbActns (new material)

Browse Source 
git-svn-id: trunk@14507 -
This commit is contained in:
kirkpatc 2008-03-13 08:23:29 +00:00
parent bbbffe0776
commit 54642e17fc
2 changed files with 477 additions and 671 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

668
docs/xml/lcl/dbactns.xml
View File

@ -1,672 +1,478 @@
<?xml version="1.0" encoding="ISO8859-1"?>
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
DBActns
====================================================================
-->
<module name="DBActns">
<short></short>
<descr>
</descr>
<short>Standard actions to be used for navigating and manipulating datasets derived from external databases</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="DB">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="ActnList">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetAction">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetAction</i> - base class for all other standard <i>TDataSet</i> actions</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TDataSetAction.FDataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TDataSetAction.SetDataSource">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetAction.SetDataSource.Value">
<short></short>
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TDataSetAction.Notification">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetAction.Notification.AComponent">
<short></short>
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetAction.Notification.Operation">
<short></short>
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TDataSetAction.GetDataSet">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TDataSetAction.GetDataSet.Result">
<short></short>
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetAction.GetDataSet.Target">
<short></short>
<short/>
</element>
<!-- function Visibility: public -->
<element name="TDataSetAction.HandlesTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TDataSetAction.HandlesTarget.Result">
<short></short>
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetAction.HandlesTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: public -->
<element name="TDataSetAction.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short>
<i>DataSource</i> - the locally-stored series of records forming the <i>DataSet</i>, derived (by a query) from the external database</short>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetFirst">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetFirst </i>- move to first record in the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetFirst.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetFirst.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetFirst.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetFirst.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetFirst.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetLast">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetLast </i>- move to last record in the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetLast.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetLast.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetLast.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetLast.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetLast.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetNext">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetNext </i>- move to next record in the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetNext.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetNext.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetNext.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetNext.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetNext.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetPrior">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetPrior </i>- move to previous (prior) record in the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetPrior.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetPrior.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetPrior.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetPrior.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetPrior.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetRefresh">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetRefresh </i>- refresh the <i>DataSet</i> by reference to the external database</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetRefresh.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetRefresh.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetRefresh.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetRefresh.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetRefresh.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetCancel">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetCancel</i> - cancel the previous operation on the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetCancel.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetCancel.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetCancel.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetCancel.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetCancel.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetDelete">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetDelete</i> - delete the current record in the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetDelete.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetDelete.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetDelete.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetDelete.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetDelete.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetEdit">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetEdit </i>- edit the current record in the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetEdit.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetEdit.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetEdit.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetEdit.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetEdit.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetInsert">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetInsert</i> - insert (append) a new record into the <i>DataSet</i>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetInsert.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetInsert.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetInsert.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetInsert.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetInsert.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TDataSetPost">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short>
<i>TDataSetPost</i> - post the editing changes on the current record permanently into the <i>DataSet</i> (may need a separate action to make changes permanently in external database)</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetPost.ExecuteTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetPost.ExecuteTarget.Target">
<short></short>
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TDataSetPost.UpdateTarget">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TDataSetPost.UpdateTarget.Target">
<short></short>
<short/>
</element>
<!-- property Visibility: published -->
<element name="TDataSetPost.DataSource">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
<short/>
<descr/>
<seealso/>
</element>
</module> <!-- DBActns -->
</module>
<!-- DBActns -->
</package>
</fpdoc-descriptions>

10
docs/xml/lcl/stdactns.xml
View File

@ -47,7 +47,7 @@
</element>
<!-- object Visibility: default -->
<element name="THintAction">
<short/>
<short><i>THintAction</i> - standard action for dealing with requests for a <i>Hint</i></short>
<descr/>
<errors/>
<seealso/>
@ -617,7 +617,7 @@
<!-- object Visibility: default -->
<element name="TFileAction">
<short>
<i>TFileAction</i> - base type for providing actions associated with various <i>file dialogs</i> and menu options</short>
<i>TFileAction</i> - base class for providing actions associated with various <i>file dialogs</i> and menu options</short>
<descr/>
<errors/>
<seealso/>
@ -1112,7 +1112,7 @@
<!-- object Visibility: default -->
<element name="TSearchAction">
<short>
<i>TSearchAction</i> - base class for the actions associated with the various <p>Search</p> menu options</short>
<i>TSearchAction</i> - base class for the actions associated with the various <i>Search</i> menu options</short>
<descr/>
<errors/>
<seealso/>
@ -1213,7 +1213,7 @@
<!-- object Visibility: default -->
<element name="TFontEdit">
<short>
<i>TFontEdit </i>- standard action for opening a <p>Font Edit</p> dialog</short>
<i>TFontEdit </i>- standard action for opening a <i>Font Edit</i> dialog</short>
<descr/>
<errors/>
<seealso/>
@ -1333,7 +1333,7 @@
<!-- object Visibility: default -->
<element name="TColorSelect">
<short>
<i>TColorSelect</i> - standard action for opening a <p>Colour Selection</p> dialog</short>
<i>TColorSelect</i> - standard action for opening a <i>Colour Selection</i> dialog</short>
<descr/>
<errors/>
<seealso/>