LazDoc - Descriptions added for ldockctrledit.xml

git-svn-id: trunk@20723 -

docs/xml/lcl/ldockctrledit.xml

@@ -7,7 +7,7 @@
   ====================================================================
 -->
     <module name="LDockCtrlEdit">
-      <short/>
+      <short>This unit contains a dialog to dock or undock a control to another</short>
       <descr/>
       <!-- unresolved type reference Visibility: default -->
       <element name="Classes">
@@ -99,80 +99,94 @@
       </element>
       <!-- object Visibility: default -->
       <element name="TLazDockControlEditorDlg">
-        <short/>
+        <short>
+          <var>TLazDockControlEditorDlg</var> - a dialog to control the docking or undocking of a control with another</short>
         <descr/>
         <errors/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.CancelButton">
-        <short/>
+        <short>
+          <var>CancelButton</var> - hitting this button cancels the action</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockControlComboBox">
-        <short/>
+        <short>
+          <var>DockControlComboBox</var> displays the various actions for selection</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockPageButton">
-        <short/>
+        <short>
+          <var>DockPageButton</var> - a SpeedButton for moving the whole page</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockBottomButton">
-        <short/>
+        <short>
+          <var>DockBottomButton</var> - a SpeedButton for docking the bottom border</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockTopButton">
-        <short/>
+        <short>
+          <var>DockTopButton</var> - a SpeedButton for docking the top border</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockRightButton">
-        <short/>
+        <short>
+          <var>DockRightButton</var> - a SpeedButton for docking the right border</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockLeftButton">
-        <short/>
+        <short>
+          <var>DockLeftButton</var> - a SpeedButton for docking the left border</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockGroupBox">
-        <short/>
+        <short>
+          <var>DockGroupBox</var> - a GroupBox to contain the docking buttons</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockControlLabel">
-        <short/>
+        <short>
+          <var>DockControlLabel</var> - a label for the dock control</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.UndockButton">
-        <short/>
+        <short>
+          <var>UndockButton</var> - a buton for undocking the control</short>
         <descr/>
         <seealso/>
       </element>
       <!-- variable Visibility: default -->
       <element name="TLazDockControlEditorDlg.UndockGroupBox">
-        <short/>
+        <short>
+          <var>UndockGroupBox</var> - a box to contain the undock button and any associated elements</short>
         <descr/>
         <seealso/>
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockBottomButtonClick">
-        <short/>
+        <short>
+          <var>DockBottomButtonClick</var> - method for responding to a click on the <var>DockBottomButton</var>
+        </short>
         <descr/>
         <errors/>
         <seealso/>
@@ -183,7 +197,8 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockControlComboBoxEditingDone">
-        <short/>
+        <short>
+          <var>DockControlComboBoxEditingDone</var> - method invoked when editing of the ComboBox is done</short>
         <descr/>
         <errors/>
         <seealso/>
@@ -194,7 +209,8 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockLeftButtonClick">
-        <short/>
+        <short>
+          <var>DockLeftButtonClick</var> - method to respond to a click on the DockLeftButton</short>
         <descr/>
         <errors/>
         <seealso/>
@@ -205,7 +221,9 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockPageButtonClick">
-        <short/>
+        <short>
+          <var>DockPageButtonClick</var> - method to respond to a click on the <var>DockPageButton</var>
+        </short>
         <descr/>
         <errors/>
         <seealso/>
@@ -216,7 +234,9 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockRightButtonClick">
-        <short/>
+        <short>
+          <var>DockRightButtonClick</var> - method to respond to a click on the <var>DockRightButton</var>
+        </short>
         <descr/>
         <errors/>
         <seealso/>
@@ -227,7 +247,9 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.DockTopButtonClick">
-        <short/>
+        <short>
+          <var>DockTopButtonClick</var> - method to respond to a click on the <var>DockTopButton</var>
+        </short>
         <descr/>
         <errors/>
         <seealso/>
@@ -238,7 +260,8 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.FormCreate">
-        <short/>
+        <short>
+          <var>FormCreate</var> - method for creating the dialog form</short>
         <descr/>
         <errors/>
         <seealso/>
@@ -249,7 +272,9 @@
       </element>
       <!-- procedure Visibility: default -->
       <element name="TLazDockControlEditorDlg.UndockButtonClick">
-        <short/>
+        <short>
+          <var>UndockButtonClick</var> - method to respond to a click on the <var>UndockButton</var>
+        </short>
         <descr/>
         <errors/>
         <seealso/>
@@ -301,16 +326,58 @@
       </element>
       <!-- property Visibility: public -->
       <element name="TLazDockControlEditorDlg.DlgResult">
-        <short/>
+        <short>
+          <var>DlgResult</var> - the result of the dialog: shows whether a moving button, an enlarging button or another control was pressed</short>
         <descr/>
         <seealso/>
       </element>
       <!-- property Visibility: public -->
       <element name="TLazDockControlEditorDlg.CurrentControlName">
-        <short/>
+        <short>
+          <var>CurrentControlName</var> - the name of the current control (the one being docked)</short>
         <descr/>
         <seealso/>
       </element>
+      <element name="TLazDockControlEditorDlg.EnlargeGroupBox">
+        <short>
+          <var>EnlargeGroupBox</var> - a GroupBox to contain the Enlarge buttons</short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeLeftSpeedButton">
+        <short>
+          <var>EnlargeLeftSpeedButton</var> - a SpeedButton for enlarging the docking control by moving the left border</short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeRightSpeedButton">
+        <short>
+          <var>EnlargeRightSpeedButton</var> - a Speedbutton for enlarging the docking control by moving its right border</short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeTopSpeedButton">
+        <short>
+          <var>EnlargeTopSpeedButton</var> - a SpeedButton for enlarging the docking control by moving its top border</short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeBottomSpeedButton">
+        <short>
+          <var>EnlargeBottomSpeedButton</var> - a SpeedButton for enlarging the docking control by moving its bottom border</short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeBottomSpeedButtonClick">
+        <short>
+          <var>EnlargeBottomSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeBottomSpeedButton</var>
+        </short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeLeftSpeedButtonClick">
+        <short>
+          <var>EnlargeLeftSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeLeftSpeedButton</var>
+        </short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeRightSpeedButtonClick">
+        <short>
+          <var>EnlargeRightSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeRightSpeedButton</var>
+        </short>
+      </element>
+      <element name="TLazDockControlEditorDlg.EnlargeTopSpeedButtonClick">
+        <short>
+          <var>EnlargeTopSpeedButtonClick</var> - method to respond to a click on the <var>EnlargeTopSpeedButton</var>
+        </short>
+      </element>
     </module>
     <!-- LDockCtrlEdit -->
   </package>