From a7f7799655c8bb0d9c2d5ca5355d46cd68e4f2ca Mon Sep 17 00:00:00 2001
From: vincents <vincents@lazarus-ide.org>
Date: Tue, 28 Apr 2009 11:13:27 +0000
Subject: [PATCH] lcl docs: updates for ModalResult from Graeme Geldenhuys

git-svn-id: trunk@19664 -
---
 docs/xml/lcl/forms.xml    | 15 +++++++++++++--
 docs/xml/lcl/stdctrls.xml |  6 +++---
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml
index 3a17a99dff..260e6b6428 100644
--- a/docs/xml/lcl/forms.xml
+++ b/docs/xml/lcl/forms.xml
@@ -1959,8 +1959,19 @@ biHelp - When you click this button a Question Cursor appears and the help routi
       <element name="TModalResult">
         <short>
           <var>TModalResult</var> - the range of values that can be returned as a modal result</short>
-        <descr/>
-        <seealso/>
+        <descr>
+          <var>TModalResult</var> represents the value returned by a modal dialog. Even though the type is defined as an integer, instead a few standard constants are used as return results in applications.</descr>
+        <seealso>
+          <link id="controls.mrNone"/>
+          <link id="controls.mrOK"/>
+          <link id="controls.mrCancel"/>
+          <link id="controls.mrAbort"/>
+          <link id="controls.mrRetry"/>
+          <link id="controls.mrIgnore"/>
+          <link id="controls.mrYes"/>
+          <link id="controls.mrNo"/>
+          <link id="controls.mrAll"/>
+        </seealso>
       </element>
       <!-- pointer type Visibility: default -->
       <element name="PModalResult">
diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml
index a6d0fead32..bfe1b6658a 100644
--- a/docs/xml/lcl/stdctrls.xml
+++ b/docs/xml/lcl/stdctrls.xml
@@ -7415,15 +7415,15 @@ is done automatically by the streaming system.
       </element>
       <!-- property Visibility: public -->
       <element name="TCustomButton.ModalResult">
-        <short>Is a Modal Result awaited? (default is false)</short>
-        <descr/>
+        <short>Determines whether the button closes its modal parent form.</short>
+        <descr>The default value is <link id="controls.mrNone">mrNone</link>.</descr>
         <seealso/>
       </element>
       <!-- property Visibility: public -->
       <element name="TCustomButton.Cancel">
         <short>Is this the Cancel button? (default setting is False)</short>
         <descr>
-          <p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</p>
+          <p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to <link id="controls.mrCancel">mrCancel</link>.</p>
         </descr>
       </element>
       <!-- property Visibility: public -->